com.alipay.sofa.jraft.entity

Class PeerId

java.lang.Object

com.alipay.sofa.jraft.entity.PeerId

All Implemented Interfaces:

Checksum, Copiable<PeerId>, Serializable

public class PeerId
extends Object
implements Copiable<PeerId>, Serializable, Checksum

Represent a participant in a replicating group.

Author:

boyan (boyan@alibaba-inc.com) 2018-Mar-12 3:27:37 PM

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PeerId	ANY_PEER

Constructor Summary

Constructors

Constructor and Description
PeerId()
PeerId(Endpoint endpoint, int idx)
PeerId(Endpoint endpoint, int idx, int priority)
PeerId(String ip, int port)
PeerId(String ip, int port, int idx)
PeerId(String ip, int port, int idx, int priority)

Method Summary

Modifier and Type	Method and Description
long	checksum() Calculate a checksum value for this entity.
PeerId	copy() Copy current object(deep-clone).
static PeerId	emptyPeer() Create an empty peer.
boolean	equals(Object obj)
Endpoint	getEndpoint()
int	getIdx()
String	getIp()
int	getPort()
int	getPriority()
int	hashCode()
boolean	isEmpty() Returns true when ip is ANY_IP, port is zero and idx is zero too.
boolean	isPriorityDisabled() To judge whether the priority election function is disabled or not in this node.
boolean	isPriorityNotElected() To judge whether this node can participate in election or not.
boolean	parse(String s) Parse peerId from string that generated by toString() This method can support parameter string values are below:
static PeerId	parsePeer(String s) Parse a peer from string in the format of "ip:port:idx", returns null if fail to parse.
void	setPriority(int priority)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.alipay.sofa.jraft.entity.Checksum

checksum, checksum

Field Detail

ANY_PEER

public static final PeerId ANY_PEER

Constructor Detail

PeerId

public PeerId()

PeerId

public PeerId(Endpoint endpoint,
              int idx)

PeerId

public PeerId(String ip,
              int port)

PeerId

public PeerId(String ip,
              int port,
              int idx)

PeerId

public PeerId(Endpoint endpoint,
              int idx,
              int priority)

PeerId

public PeerId(String ip,
              int port,
              int idx,
              int priority)

Method Detail

checksum

public long checksum()

Description copied from interface: Checksum

Calculate a checksum value for this entity.

Specified by:

checksum in interface Checksum

Returns:

checksum value

emptyPeer

public static PeerId emptyPeer()

Create an empty peer.

Returns:

empty peer

copy

public PeerId copy()

Description copied from interface: Copiable

Copy current object(deep-clone).

Specified by:

copy in interface Copiable<PeerId>

parsePeer

public static PeerId parsePeer(String s)

Parse a peer from string in the format of "ip:port:idx", returns null if fail to parse.

Parameters:

s - input string with the format of "ip:port:idx"

Returns:

parsed peer

getEndpoint

public Endpoint getEndpoint()

getIp

public String getIp()

getPort

public int getPort()

getIdx

public int getIdx()

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

isEmpty

public boolean isEmpty()

Returns true when ip is ANY_IP, port is zero and idx is zero too.

toString

public String toString()

Overrides:

toString in class Object

parse

public boolean parse(String s)

Parse peerId from string that generated by toString() This method can support parameter string values are below:

 PeerId.parse("a:b")          = new PeerId("a", "b", 0 , -1)
 PeerId.parse("a:b:c")        = new PeerId("a", "b", "c", -1)
 PeerId.parse("a:b::d")       = new PeerId("a", "b", 0, "d")
 PeerId.parse("a:b:c:d")      = new PeerId("a", "b", "c", "d")
 

isPriorityNotElected

public boolean isPriorityNotElected()

To judge whether this node can participate in election or not.

Returns:

the restul that whether this node can participate in election or not.

isPriorityDisabled

public boolean isPriorityDisabled()

To judge whether the priority election function is disabled or not in this node.

Returns:

the result that whether this node has priority election function or not.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object