net.tomp2p.relay

Class BaseRelayForwarderRPC

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.relay.BaseRelayForwarderRPC

All Implemented Interfaces:

PeerStatusListener

Direct Known Subclasses:

AndroidForwarderRPC, OpenTCPForwarderRPC

public abstract class BaseRelayForwarderRPC
extends DispatchHandler
implements PeerStatusListener

Abstract class that provides the basic functionality to handle relay requests at the relay server. It also acts as a dispatcher for different kinds of messages. The RelayForwarder is responsible for forwarding all messages that are received on a relay peer, but are intended for an unreachable peer that is connected to the relay peer. Every unreachable node has an own instance of this class at the relay server.

Author:

Nico Rutishauser, Raphael Voellmy

Constructor Summary

Constructors

Constructor and Description
BaseRelayForwarderRPC(Peer peer, PeerAddress unreachablePeer, RelayType relayType)

Method Summary

Methods

Modifier and Type	Method and Description
abstract FutureDone<Message>	forwardToUnreachable(Message message) Forwards a message to the unrachable peer.
Collection<PeerAddress>	getPeerMap() Returns the current peer map from the mobile device
void	handleResponse(Message message, PeerConnection peerConnection, boolean sign, Responder responder) Receive a message at the relay server from a given peer
void	handleResponse(Message message, Responder responder) Receive a message at the relay server from a given peer
protected abstract boolean	isAlive() Checks whether the relayed peer is still alive.
boolean	peerFailed(PeerAddress remotePeer, PeerException exception)
boolean	peerFound(PeerAddress remotePeer, PeerAddress referrer, PeerConnection peerConnection)
protected abstract void	peerMapUpdated() Is called when the unreachable peer sent an update to the relay peer
Number160	relayPeerId()
void	setPeerMap(List<Map<Number160,PeerStatistic>> peerMap) Update the peerMap of the unreachable peer
PeerAddress	unreachablePeerAddress()
protected Number160	unreachablePeerId()

Methods inherited from class net.tomp2p.rpc.DispatchHandler

connectionBean, createMessage, createResponseMessage, createResponseMessage, forwardMessage, peerBean, register, register, sign

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRelayForwarderRPC

public BaseRelayForwarderRPC(Peer peer,
                     PeerAddress unreachablePeer,
                     RelayType relayType)

Method Detail

unreachablePeerAddress

public final PeerAddress unreachablePeerAddress()

unreachablePeerId

protected final Number160 unreachablePeerId()

peerFailed

public final boolean peerFailed(PeerAddress remotePeer,
                 PeerException exception)

Specified by:

peerFailed in interface PeerStatusListener

peerFound

public final boolean peerFound(PeerAddress remotePeer,
                PeerAddress referrer,
                PeerConnection peerConnection)

Specified by:

peerFound in interface PeerStatusListener

relayPeerId

public final Number160 relayPeerId()

handleResponse

public final void handleResponse(Message message,
                  PeerConnection peerConnection,
                  boolean sign,
                  Responder responder)
                          throws Exception

Receive a message at the relay server from a given peer

Specified by:

handleResponse in class DispatchHandler

Throws:

Exception

handleResponse

public final void handleResponse(Message message,
                  Responder responder)

Receive a message at the relay server from a given peer

forwardToUnreachable

public abstract FutureDone<Message> forwardToUnreachable(Message message)

Forwards a message to the unrachable peer. The implementation should notify the unreachable peer and return a response as soon as possible.

Parameters:

message - the message that is intended for the unreachable peer

sender - the requester

Returns:

the response to the requester

isAlive

protected abstract boolean isAlive()

Checks whether the relayed peer is still alive.

Returns:

getPeerMap

public final Collection<PeerAddress> getPeerMap()

Returns the current peer map from the mobile device

setPeerMap

public final void setPeerMap(List<Map<Number160,PeerStatistic>> peerMap)

Update the peerMap of the unreachable peer

peerMapUpdated

protected abstract void peerMapUpdated()

Is called when the unreachable peer sent an update to the relay peer