net.tomp2p.relay

Class DistributedRelay

java.lang.Object

net.tomp2p.relay.DistributedRelay

All Implemented Interfaces:

GCMMessageHandler

public class DistributedRelay
extends Object
implements GCMMessageHandler

The relay manager is responsible for setting up and maintaining connections to relay peers and contains all information about the relays.

Author:

Raphael Voellmy, Thomas Bocek, Nico Rutishauser

Constructor Summary

Constructors

Constructor and Description
DistributedRelay(Peer peer, RelayRPC relayRPC, ConnectionConfiguration config, RelayConfig relayConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelayListener(RelayListener relayListener)
void	onGCMMessageArrival(String peerId) Call this when a GCM message arrives
RelayConfig	relayConfig()
List<BaseRelayConnection>	relays() Returns connections to current relay peers
FutureRelay	setupRelays(FutureRelay futureRelay) Sets up relay connections to other peers.
FutureForkJoin<FutureDone<Void>>	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedRelay

public DistributedRelay(Peer peer,
                RelayRPC relayRPC,
                ConnectionConfiguration config,
                RelayConfig relayConfig)

Parameters:

peer - the unreachable peer

relayRPC - the relay RPC

maxFail -

relayConfig -

maxRelays - maximum number of relay peers to set up

relayType - the kind of the relay connection

Method Detail

relayConfig

public RelayConfig relayConfig()

relays

public List<BaseRelayConnection> relays()

Returns connections to current relay peers

Returns:

List of PeerAddresses of the relay peers (copy)

addRelayListener

public void addRelayListener(RelayListener relayListener)

shutdown

public FutureForkJoin<FutureDone<Void>> shutdown()

setupRelays

public FutureRelay setupRelays(FutureRelay futureRelay)

Sets up relay connections to other peers. The number of relays to set up is determined by PeerAddress#MAX_RELAYS or passed to the constructor of this class. It is important that we call this after we bootstrapped and have recent information in our peer map.

Returns:

RelayFuture containing a DistributedRelay instance

onGCMMessageArrival

public void onGCMMessageArrival(String peerId)

Description copied from interface: GCMMessageHandler

Call this when a GCM message arrives

Specified by:

onGCMMessageArrival in interface GCMMessageHandler

Parameters:

peerId - the collapse key of the GCM message is the same as the relay's peer id