net.tomp2p.relay

Class RelayManager

java.lang.Object

net.tomp2p.relay.RelayManager

public class RelayManager
extends Object

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

Author:

Raphael Voellmy

Constructor Summary

Constructors

Constructor and Description
RelayManager(Peer peer, int maxRelays, RelayRPC relayRPC)
RelayManager(Peer peer, RelayRPC relayRPC)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<PeerAddress>	getRelayAddresses() Returns addresses of current relay peers
Collection<PeerAddress>	getRelayCandidates() Get a collection of current relay candidates.
int	maxRelays()
RelayFuture	setupRelays(BootstrapBuilder bootstrapBuilder) Sets up relay connections to other peers.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelayManager

public RelayManager(Peer peer,
            RelayRPC relayRPC)

Parameters:

peer - the unreachable peer

relayRPC - the relay RPC

RelayManager

public RelayManager(Peer peer,
            int maxRelays,
            RelayRPC relayRPC)

Parameters:

peer - the unreachable peer

relayRPC - the relay RPC

maxRelays - maximum number of relay peers to set up

Method Detail

getRelayAddresses

public Collection<PeerAddress> getRelayAddresses()

Returns addresses of current relay peers

Returns:

Collection of PeerAddresses of the relay peers

getRelayCandidates

public Collection<PeerAddress> getRelayCandidates()

Get a collection of current relay candidates. Relay candidates are all peers that are neighbors of the unreachable peer, are not unreachable themselves and are not already relays of this peer

Returns:

collection of peer addresses of peers that are candidates of becoming relay peers.

maxRelays

public int maxRelays()

Returns:

maximum number of allowed relay peers

setupRelays

public RelayFuture setupRelays(BootstrapBuilder bootstrapBuilder)

Sets up relay connections to other peers.

Returns:

RelayFuture containing a RelayManager instance