net.tomp2p.relay

Class RelayBuilder

java.lang.Object

net.tomp2p.relay.RelayBuilder

All Implemented Interfaces:

Builder

public class RelayBuilder
extends Object
implements Builder

Constructor Summary

Constructors

Constructor and Description
RelayBuilder(Peer peer)

Method Summary

Methods

Modifier and Type	Method and Description
RelayBuilder	bootstrapAddress(PeerAddress bootrapAddress) Sets the bootstrap address.
RelayBuilder	bootstrapBuilder(BootstrapBuilder bootstrapBuilder) Specify a bootstrap builder that will be used to bootstrap during the process of setting up relay peers and after that.
RelayBuilder	bootstrapInetAddress(InetAddress bootstrapInetAddress) Set a bootstrap address for setting up the relay peers.
int	failedRelayWaitTime()
RelayBuilder	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
int	maxRelays()
RelayBuilder	maxRelays(int maxRelays) Sets the maximum number of peers.
RelayBuilder	minRelays(int minRelays) Defines how many relays have to be set up.
int	peerMapUpdateInterval()
RelayBuilder	peerMapUpdateInterval(int peerMapUpdateInterval) Defines the time interval of sending the peer map of the unreachable peer to its relays.
RelayBuilder	ports(int port) Sets the ports of the bootstrap peer.
int	relaySearchInterval()
RelayBuilder	relaySearchInterval(int relaySearchInterval) If a relay peer failed but no new possible relay peers could be found, the peer will actively search for new relay peers.
RelayFuture	start() Start setting up the relay peers

Methods inherited from class java.lang.Object

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

Constructor Detail

RelayBuilder

public RelayBuilder(Peer peer)

Method Detail

failedRelayWaitTime

public RelayBuilder 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()

relaySearchInterval

public RelayBuilder relaySearchInterval(int relaySearchInterval)

If a relay peer failed but no new possible relay peers could be found, the peer will actively search for new relay peers. With this method, the interval in which the peer searches for new relays can be defined.

Parameters:

relaySearchInterval - search interval in seconds

Returns:

this instance

relaySearchInterval

public int relaySearchInterval()

Returns:

the interval in seconds

minRelays

public RelayBuilder minRelays(int minRelays)

Defines how many relays have to be set up. If less than minRelays relay peers could be set up, it is considered a fail.

Parameters:

minRelays - minimum amount of relays

Returns:

this instance

maxRelays

public RelayBuilder maxRelays(int maxRelays)

Sets the maximum number of peers. A peer can currently have up to 5 relay peers (specified in PeerAddress.MAX_RELAYS). Any number higher than 5 will result in 5 relay peers.

Parameters:

maxRelays - maximum number of relay peers (maximum specified in PeerAddress.MAX_RELAYS). Currently up to 5 relay peers are allowed

Returns:

this instance

maxRelays

public int maxRelays()

Returns:

maximum number of relays

peerMapUpdateInterval

public RelayBuilder peerMapUpdateInterval(int peerMapUpdateInterval)

Defines the time interval 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 - interval of updates in seconds

Returns:

this instance

peerMapUpdateInterval

public int peerMapUpdateInterval()

Returns:

the peer map update interval in seconds

bootstrapAddress

public RelayBuilder bootstrapAddress(PeerAddress bootrapAddress)

Sets the bootstrap address. For more specific bootstrap configuration use bootstrapBuilder(BootstrapBuilder)

Parameters:

bootrapAddress - PeerAddress of any peer in the network.

Returns:

this instance

bootstrapInetAddress

public RelayBuilder bootstrapInetAddress(InetAddress bootstrapInetAddress)

Set a bootstrap address for setting up the relay peers. If ports are not set using ports(int) a default port is used.

Parameters:

bootstrapInetAddress - The bootstrap address

Returns:

this instance

ports

public RelayBuilder ports(int port)

Sets the ports of the bootstrap peer. For more specific bootstrap configuration use bootstrapBuilder(BootstrapBuilder)

Parameters:

port - The port of the bootstrap peer

Returns:

this instance

bootstrapBuilder

public RelayBuilder bootstrapBuilder(BootstrapBuilder bootstrapBuilder)

Specify a bootstrap builder that will be used to bootstrap during the process of setting up relay peers and after that.

Parameters:

bootstrapBuilder - The bootstrap builder

Returns:

this instance

start

public RelayFuture start()

Start setting up the relay peers

Specified by:

start in interface Builder

Returns:

A RelayFuture