net.tomp2p.relay

Class RelayClientConfig

java.lang.Object

net.tomp2p.relay.RelayClientConfig

Direct Known Subclasses:

BufferedTCPRelayClientConfig, TCPRelayClientConfig

public abstract class RelayClientConfig
extends Object

Holds multiple relay types with their configuration

Author:

Nico Rutishauser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelayClientConfig(RelayType type, int peerMapUpdateInterval, int failedRelayWaitTime, int maxFail)

Method Summary

Methods

Modifier and Type	Method and Description
void	addManualRelay(PeerAddress manualRelay) Add a relay to the relays list
abstract BaseRelayClient	createClient(PeerConnection connection, Peer peer) Creates a client object
int	failedRelayWaitTime()
RelayClientConfig	failedRelayWaitTime(int failedRelayWaitTime) Defines how many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again
Collection<PeerAddress>	manualRelays()
RelayClientConfig	manualRelays(Collection<PeerAddress> manualRelays) Set the relay list where the peer should connect to
int	maxFail()
RelayClientConfig	maxFail(int maxFail) Defines how many times a setup with a relay can fail before it's ignored
int	peerMapUpdateInterval() Get the peer map update interval in seconds
RelayClientConfig	peerMapUpdateInterval(int peerMapUpdateInterval) Defines the time interval (in seconds) of sending the peer map of the unreachable peer to its relays.
abstract void	prepareMapUpdateMessage(Message message) Gives the opportunity to add more data to the map update message.
abstract void	prepareSetupMessage(Message message) Gives the opportunity to add more data to the setup message which is sent from the unreachable peer to the relay peer.
String	toString()
RelayType	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RelayClientConfig

protected RelayClientConfig(RelayType type,
                 int peerMapUpdateInterval,
                 int failedRelayWaitTime,
                 int maxFail)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

type

public RelayType type()

Returns:

the relay type

peerMapUpdateInterval

public int peerMapUpdateInterval()

Get the peer map update interval in seconds

peerMapUpdateInterval

public RelayClientConfig peerMapUpdateInterval(int peerMapUpdateInterval)

Defines the time interval (in seconds) of sending the peer map of the unreachable peer to its relays. The routing requests are not relayed to the unreachable peer but handled by the relay peers. Therefore, the relay peers should always have an up-to-date peer map of the relayed peer

Parameters:

peerMapUpdateInterval - the interval of updating the own peer map at the relay

Returns:

this instance

addManualRelay

public void addManualRelay(PeerAddress manualRelay)

Add a relay to the relays list

manualRelays

public RelayClientConfig manualRelays(Collection<PeerAddress> manualRelays)

Set the relay list where the peer should connect to

Parameters:

manualRelays - publicly reachable relay nodes

Returns:

this instance

manualRelays

public Collection<PeerAddress> manualRelays()

Returns:

the currently configured list of relay peers

failedRelayWaitTime

public RelayClientConfig failedRelayWaitTime(int failedRelayWaitTime)

Defines how many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again

Parameters:

failedRelayWaitTime - wait time in seconds

Returns:

this instance

failedRelayWaitTime

public int failedRelayWaitTime()

Returns:

How many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again

maxFail

public RelayClientConfig maxFail(int maxFail)

Defines how many times a setup with a relay can fail before it's ignored

Parameters:

maxFail - the allowed number of fails

Returns:

this instance

maxFail

public int maxFail()

Returns:

the maximum number of allowed fails

createClient

public abstract BaseRelayClient createClient(PeerConnection connection,
                           Peer peer)

Creates a client object

prepareSetupMessage

public abstract void prepareSetupMessage(Message message)

Gives the opportunity to add more data to the setup message which is sent from the unreachable peer to the relay peer.

Parameters:

message - the message that is sent to the relay peer.

prepareMapUpdateMessage

public abstract void prepareMapUpdateMessage(Message message)

Gives the opportunity to add more data to the map update message.

Parameters:

message - the message which is regularly sent to the relay peer to update the routing table.