net.tomp2p.relay

Class DistributedRelay

java.lang.Object

net.tomp2p.relay.DistributedRelay

All Implemented Interfaces:

BufferRequestListener

public class DistributedRelay
extends Object
implements BufferRequestListener

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, RelayClientConfig relayConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelayListener(RelayListener relayListener)
List<BaseRelayClient>	relayClients() Returns connections to current relay peers
RelayClientConfig	relayConfig()
FutureDone<Void>	sendBufferRequest(String relayPeerId) Call this if the buffer should be obtained from a relay peer.
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,
                RelayClientConfig 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 RelayClientConfig relayConfig()

relayClients

public List<BaseRelayClient> relayClients()

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

sendBufferRequest

public FutureDone<Void> sendBufferRequest(String relayPeerId)

Description copied from interface: BufferRequestListener

Call this if the buffer should be obtained from a relay peer.

Specified by:

sendBufferRequest in interface BufferRequestListener

Parameters:

relayPeerId - the relay's peer id