net.tomp2p.peers

Class PeerAddress

java.lang.Object

net.tomp2p.peers.PeerAddress

All Implemented Interfaces:

Serializable, Comparable<PeerAddress>

public final class PeerAddress
extends Object
implements Comparable<PeerAddress>, Serializable

A PeerAddress contains the node ID and how to contact this node using both TCP and UDP. This class is thread safe (or it does not matter if its not). The format looks as follows:

 20 bytes - Number160
 2 bytes - Header 
  - 1 byte options: IPv6, firewalled UDP, firewalled TCP
  - 1 byte relays:
    - first 3 bits: number of relays (max 5.)
    - second 5 bits: if the 5 relays are IPv6 (bit set) or not (no bit set)
 2 bytes - TCP port
 2 bytes - UDP port
 4 or 16 bytes - Inet Address
 0-5 relays:
  - 2 bytes - TCP port
  - 2 bytes - UDP port
  - 4 or 16 bytes - Inet Address
 

Author:

Thomas Bocek

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RELAYS
static int	MAX_SIZE
static int	MIN_SIZE

Constructor Summary

Constructors

Constructor and Description
PeerAddress(byte[] me) Creates a new peeraddress, where the byte array has to be in the rigth format and in the right size.
PeerAddress(byte[] me, int initialOffset) Creates a PeerAddress from a continuous byte array.
PeerAddress(io.netty.buffer.ByteBuf channelBuffer) Creates a PeerAddress from a Netty ByteBuf.
PeerAddress(Number160 id) If you only need to know the id.
PeerAddress(Number160 id, InetAddress address) If you only need to know the id and InetAddress.
PeerAddress(Number160 peerId, InetAddress inetAddress, int tcpPort, int udpPort) Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).
PeerAddress(Number160 id, InetAddress inetAddress, int tcpPort, int udpPort, int options) Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).
PeerAddress(Number160 id, InetSocketAddress inetSocketAddress) Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).
PeerAddress(Number160 id, PeerSocketAddress peerSocketAddress, boolean firewalledTCP, boolean firewalledUDP, boolean isRelayed, PeerSocketAddress[] peerSocketAddresses) Creates a PeerAddress if all the values are known.
PeerAddress(Number160 id, String address, int tcpPort, int udpPort) Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).

Method Summary

Methods

Modifier and Type	Method and Description
PeerAddress	changeAddress(InetAddress inetAddress) Create a new PeerAddress and change the InetAddress.
PeerAddress	changeFirewalledTCP(boolean firewalledTCP) Create a new PeerAddress and change the firewalledTCP status.
PeerAddress	changeFirewalledUDP(boolean firewalledUDP) Create a new PeerAddress and change the firewallUDP status.
PeerAddress	changePeerId(Number160 peerId) Create a new PeerAddress and change the peer id.
PeerAddress	changePeerSocketAddress(PeerSocketAddress peerSocketAddress)
PeerAddress	changePeerSocketAddresses(PeerSocketAddress[] peerSocketAddresses)
PeerAddress	changePorts(int tcpPort, int udpPort) Create a new PeerAddress and change the TCP and UDP ports.
int	compareTo(PeerAddress nodeAddress)
InetSocketAddress	createSocketTCP() Returns the socket address.
InetSocketAddress	createSocketUDP() Returns the socket address.
boolean	equals(Object obj)
InetAddress	getInetAddress() Returns the address or null if no address set.
byte	getOptions()
Number160	getPeerId() The id of the peer.
PeerSocketAddress[]	getPeerSocketAddresses()
byte	getRelays()
int	hashCode()
boolean	isFirewalledTCP()
boolean	isFirewalledUDP()
boolean	isIPv4()
boolean	isIPv6()
boolean	isRelayed()
int	offset() When deserializing, we need to know how much we deserialized from the constructor call.
PeerSocketAddress	peerSocketAddress()
int	size()
static int	size(int header) Calculates the size based on the two header bytes.
static int	size(int options, int relays) Calculates the size based on the two header bytes.
int	tcpPort()
byte[]	toByteArray() Serializes to a new array with the proper size.
int	toByteArray(byte[] me, int offset) Serializes to an existing array.
String	toString()
int	udpPort()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SIZE

public static final int MAX_SIZE

See Also:

Constant Field Values

MIN_SIZE

public static final int MIN_SIZE

See Also:

Constant Field Values

MAX_RELAYS

public static final int MAX_RELAYS

See Also:

Constant Field Values

Constructor Detail

PeerAddress

public PeerAddress(byte[] me)

Creates a new peeraddress, where the byte array has to be in the rigth format and in the right size. The new offset can be accessed with offset().

Parameters:

me - The serialized array

PeerAddress

public PeerAddress(byte[] me,
           int initialOffset)

Creates a PeerAddress from a continuous byte array. This is useful if you don't know the size beforehand. The new offset can be accessed with offset().

Parameters:

me - The serialized array

initialOffset - the offset, where to start

PeerAddress

public PeerAddress(io.netty.buffer.ByteBuf channelBuffer)

Creates a PeerAddress from a Netty ByteBuf.

Parameters:

channelBuffer - The channel buffer to read from

PeerAddress

public PeerAddress(Number160 id)

If you only need to know the id.

Parameters:

id - The id of the peer

PeerAddress

public PeerAddress(Number160 id,
           InetAddress address)

If you only need to know the id and InetAddress.

Parameters:

id - The id of the peer

address - The InetAddress of the peer

PeerAddress

public PeerAddress(Number160 id,
           PeerSocketAddress peerSocketAddress,
           boolean firewalledTCP,
           boolean firewalledUDP,
           boolean isRelayed,
           PeerSocketAddress[] peerSocketAddresses)

Creates a PeerAddress if all the values are known.

Parameters:

id - The id of the peer

peerSocketAddress - The peer socket address including both ports UDP and TCP

firewalledUDP - Indicates if peer is not reachable via UDP

firewalledTCP - Indicates if peer is not reachable via TCP

isRelay - Indicates if peer used as a relay

peerSocketAddresses - the relay peers

PeerAddress

public PeerAddress(Number160 peerId,
           InetAddress inetAddress,
           int tcpPort,
           int udpPort)

Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).

Parameters:

peerId - The id of the peer

inetAddress - The inetAddress of the peer, how to reach this peer

tcpPort - The TCP port how to reach the peer

udpPort - The UDP port how to reach the peer

PeerAddress

public PeerAddress(Number160 id,
           String address,
           int tcpPort,
           int udpPort)
            throws UnknownHostException

Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).

Parameters:

id - The id of the peer

address - The address of the peer, how to reach this peer

tcpPort - The TCP port how to reach the peer

udpPort - The UDP port how to reach the peer

Throws:

UnknownHostException - If no IP address for the host could be found, or if a scope_id was specified for a global IPv6 address.

PeerAddress

public PeerAddress(Number160 id,
           InetSocketAddress inetSocketAddress)

Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).

Parameters:

id - The id of the peer

inetSocketAddress - The socket address of the peer, how to reach this peer. Both UPD and TCP will be set to the same port

PeerAddress

public PeerAddress(Number160 id,
           InetAddress inetAddress,
           int tcpPort,
           int udpPort,
           int options)

Facade for #PeerAddress(Number160, InetAddress, int, int, boolean, boolean, PeerSocketAddress[]).

Parameters:

id - The id of the peer

inetAddress - The address of the peer, how to reach this peer

tcpPort - The TCP port how to reach the peer

udpPort - The UDP port how to reach the peer

options - Set options

Method Detail

offset

public int offset()

When deserializing, we need to know how much we deserialized from the constructor call.

Returns:

The new offset

size

public int size()

Returns:

The size of the serialized peer address

toByteArray

public byte[] toByteArray()

Serializes to a new array with the proper size.

Returns:

The serialized representation.

toByteArray

public int toByteArray(byte[] me,
              int offset)

Serializes to an existing array.

Parameters:

me - The array where the result should be stored

offset - The offset where to start to save the result in the byte array

Returns:

The new offset.

peerSocketAddress

public PeerSocketAddress peerSocketAddress()

getInetAddress

public InetAddress getInetAddress()

Returns the address or null if no address set.

Returns:

The address of this peer

createSocketTCP

public InetSocketAddress createSocketTCP()

Returns the socket address.

Returns:

The socket address how to reach this peer

createSocketUDP

public InetSocketAddress createSocketUDP()

Returns the socket address.

Returns:

The socket address how to reach this peer

getPeerId

public Number160 getPeerId()

The id of the peer. A peer cannot change its id.

Returns:

Id of the peer

getOptions

public byte getOptions()

Returns:

The encoded options

getRelays

public byte getRelays()

Returns:

The encoded relays. There are maximum 5 relays

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(PeerAddress nodeAddress)

Specified by:

compareTo in interface Comparable<PeerAddress>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

udpPort

public int udpPort()

Returns:

TCP port

tcpPort

public int tcpPort()

Returns:

UDP port

isFirewalledUDP

public boolean isFirewalledUDP()

Returns:

True if the peer cannot be reached via UDP

isFirewalledTCP

public boolean isFirewalledTCP()

Returns:

True if the peer cannot be reached via TCP

isIPv6

public boolean isIPv6()

Returns:

True if the inet address is IPv6

isIPv4

public boolean isIPv4()

Returns:

True if the inet address is IPv4

isRelayed

public boolean isRelayed()

Returns:

If this peer address is used as a relay

changeFirewalledUDP

public PeerAddress changeFirewalledUDP(boolean firewalledUDP)

Create a new PeerAddress and change the firewallUDP status.

Parameters:

firewalledUDP - the new status

Returns:

The newly created peer address

changeFirewalledTCP

public PeerAddress changeFirewalledTCP(boolean firewalledTCP)

Create a new PeerAddress and change the firewalledTCP status.

Parameters:

firewalledTCP - the new status

Returns:

The newly created peer address

changePorts

public PeerAddress changePorts(int tcpPort,
                      int udpPort)

Create a new PeerAddress and change the TCP and UDP ports.

Parameters:

tcpPort - The new TCP port

udpPort - The new UDP port

Returns:

The newly created peer address

changeAddress

public PeerAddress changeAddress(InetAddress inetAddress)

Create a new PeerAddress and change the InetAddress.

Parameters:

inetAddress - The new InetAddress

Returns:

The newly created peer address

changePeerId

public PeerAddress changePeerId(Number160 peerId)

Create a new PeerAddress and change the peer id.

Parameters:

peerId - the new peer id

Returns:

The newly created peer address

changePeerSocketAddresses

public PeerAddress changePeerSocketAddresses(PeerSocketAddress[] peerSocketAddresses)

changePeerSocketAddress

public PeerAddress changePeerSocketAddress(PeerSocketAddress peerSocketAddress)

getPeerSocketAddresses

public PeerSocketAddress[] getPeerSocketAddresses()

Returns:

The relay peers

size

public static int size(int header)

Calculates the size based on the two header bytes.

Parameters:

header - The header is in the lower 16 bits

Returns:

the expected size of the peer address

size

public static int size(int options,
       int relays)

Calculates the size based on the two header bytes.

Parameters:

options - The option tells us if the inet address is IPv4 or IPv6

relays - The relays tells us how many relays we have and what type it is

Returns:

returns the expected size of the peer address