net.tomp2p.relay

Class BaseRelayClient

java.lang.Object

net.tomp2p.relay.BaseRelayClient

Direct Known Subclasses:

BufferedRelayClient, TCPRelayClient

public abstract class BaseRelayClient
extends Object

Every firewalled peer has one or multiple relay servers. This class represents one of these relays (at the client side).

Author:

Nico Rutishauser

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<RelayListener>	listeners

Constructor Summary

Constructors

Constructor and Description
BaseRelayClient(PeerAddress relayAddress)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCloseListener(RelayListener listener) Adds a close listener for an open peer connection, so that if the connection to the relay peer drops, a new relay is found and a new relay connection is established
protected void	notifyCloseListeners() Call this to notify all listeners attached by addCloseListener(RelayListener)
abstract void	onMapUpdateFailed() Is called when the PeerMapUpdateTask failed to send the new map.
abstract void	onMapUpdateSuccess() Is called when the PeerMapUpdateTask successfully sent the map to the relay peer.
PeerAddress	relayAddress()
abstract FutureResponse	sendToRelay(Message message)
abstract FutureDone<Void>	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final Set<RelayListener> listeners

Constructor Detail

BaseRelayClient

public BaseRelayClient(PeerAddress relayAddress)

Method Detail

relayAddress

public PeerAddress relayAddress()

sendToRelay

public abstract FutureResponse sendToRelay(Message message)

shutdown

public abstract FutureDone<Void> shutdown()

onMapUpdateSuccess

public abstract void onMapUpdateSuccess()

Is called when the PeerMapUpdateTask successfully sent the map to the relay peer.

onMapUpdateFailed

public abstract void onMapUpdateFailed()

Is called when the PeerMapUpdateTask failed to send the new map. This can act as an indicator that the relay peer is now offline.

addCloseListener

public final void addCloseListener(RelayListener listener)

Adds a close listener for an open peer connection, so that if the connection to the relay peer drops, a new relay is found and a new relay connection is established

Parameters:

peerConnection - the peer connection on which to add a close listener

bootstrapBuilder - bootstrap builder, used to find neighbors of this peer

notifyCloseListeners

protected final void notifyCloseListeners()

Call this to notify all listeners attached by addCloseListener(RelayListener)