net.tomp2p.relay

Class RelayConfig

java.lang.Object

net.tomp2p.relay.RelayConfig

public class RelayConfig
extends Object

Holds multiple relay types with their configuration

Author:

Nico Rutishauser

Method Summary

Methods

Modifier and Type	Method and Description
void	addManualRelay(PeerAddress manualRelay) Add a relay to the relays list
static RelayConfig	Android(String registrationId) Creates an Android relay configuration.
static RelayConfig	Android(String registrationId, MessageBufferConfiguration bufferConfiguration) Creates an Android relay configuration having a buffer for received GCM messages.
MessageBufferConfiguration	bufferConfiguration() Only used for RelayConfig#ANDROID
int	failedRelayWaitTime()
RelayConfig	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>	gcmServers() Only used for RelayConfig#ANDROID
RelayConfig	gcmServers(Set<PeerAddress> gcmServers) Only used for RelayConfig#ANDROID Defines well-known peers that have the ability to send messages over Google Cloud Messaging.
Collection<PeerAddress>	manualRelays()
RelayConfig	manualRelays(Collection<PeerAddress> manualRelays) Set the relay list where the peer should connect to
int	maxFail()
RelayConfig	maxFail(int maxFail) Defines how many times a setup with a relay can fail before it's ignored
static RelayConfig	OpenTCP() Creates a TCP relay configuration
int	peerMapUpdateInterval() Get the peer map update interval
RelayConfig	peerMapUpdateInterval(int peerMapUpdateInterval) Defines the time interval of sending the peer map of the unreachable peer to its relays.
String	registrationId() Only used for RelayConfig#ANDROID
String	toString()
RelayType	type()

Methods inherited from class java.lang.Object

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

Method Detail

OpenTCP

public static RelayConfig OpenTCP()

Creates a TCP relay configuration

Returns:

Android

public static RelayConfig Android(String registrationId)

Creates an Android relay configuration. The messages at the relayed peer are not buffered.

Parameters:

registrationId - the Google Cloud Messaging registration ID. This can be obtained on an Android device by providing the correct senderID. The registration ID is unique for each device for each senderID.

Returns:

Android

public static RelayConfig Android(String registrationId,
                  MessageBufferConfiguration bufferConfiguration)

Creates an Android relay configuration having a buffer for received GCM messages.

Parameters:

registrationId - the Google Cloud Messaging registration ID. This can be obtained on an Android device by providing the correct senderID. The registration ID is unique for each device for each senderID.

bufferConfiguration - to buffer received GCM messages. Having multiple relays, this can help to reduce battery consumption.

Returns:

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

peerMapUpdateInterval

public RelayConfig 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 - 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 RelayConfig 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 RelayConfig 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 RelayConfig 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

registrationId

public String registrationId()

Only used for RelayConfig#ANDROID

Returns:

the GCM registration ID. If this peer is an unreachable Android device, this value needs to be provided.

bufferConfiguration

public MessageBufferConfiguration bufferConfiguration()

Only used for RelayConfig#ANDROID

Returns:

the configuration for the GCM message buffer at the mobile device.

gcmServers

public Collection<PeerAddress> gcmServers()

Only used for RelayConfig#ANDROID

Returns:

a collection of known GCM servers which are known to be able to send GCM messages. A GCM server can be configured by setting PeerBuilderNAT.gcmAuthenticationKey(String).

gcmServers

public RelayConfig gcmServers(Set<PeerAddress> gcmServers)

Only used for RelayConfig#ANDROID
Defines well-known peers that have the ability to send messages over Google Cloud Messaging. If an empty list or null is provided, the relays try to send it by themselves or deny the relay connection.

Parameters:

gcmServers - a set of peers that can send GCM messages

Returns:

this instance