net.tomp2p.relay.buffer

Class BufferedRelayServer

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.relay.BaseRelayServer

net.tomp2p.relay.buffer.BufferedRelayServer

All Implemented Interfaces:

PeerStatusListener, MessageBufferListener<Message>

Direct Known Subclasses:

BufferedTCPRelayServer

public abstract class BufferedRelayServer
extends BaseRelayServer
implements MessageBufferListener<Message>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BufferedRelayServer(Peer peer, PeerAddress unreachablePeer, RelayType relayType, MessageBufferConfiguration bufferConfig)

Method Summary

Methods

Modifier and Type	Method and Description
MessageBufferConfiguration	bufferConfiguration() Get the buffer configuration.
void	bufferFlushed(List<Message> messages) Notification when the buffer at the relay peer has been flushed manually (using MessageBuffer.flushNow().
void	bufferFull(List<Message> messages) Notification when the buffer at the relay peer is full.
Buffer	collectBufferedMessages() Retrieves the messages that are ready to send.
FutureDone<Message>	forwardToUnreachable(Message message) Forwards a message to the unrachable peer.
protected abstract void	onBufferCollected() Called when the buffer has been collected by the unreachable peer
abstract void	onBufferFull() Called when the buffer is full and has been triggered.
protected void	peerMapUpdated(Message originalMessage, Message preparedResponse) Is called when the unreachable peer sent an update to the relay peer.

Methods inherited from class net.tomp2p.relay.BaseRelayServer

addOfflineListener, getPeerMap, handleResponse, handleResponse, isAlive, notifyOfflineListeners, peerFailed, peerFound, relayPeerId, setPeerMap, unreachablePeerAddress, 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

BufferedRelayServer

protected BufferedRelayServer(Peer peer,
                   PeerAddress unreachablePeer,
                   RelayType relayType,
                   MessageBufferConfiguration bufferConfig)

Method Detail

forwardToUnreachable

public FutureDone<Message> forwardToUnreachable(Message message)

Description copied from class: BaseRelayServer

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

Specified by:

forwardToUnreachable in class BaseRelayServer

Parameters:

message - the message that is intended for the unreachable peer

Returns:

the response to the requester

bufferFull

public void bufferFull(List<Message> messages)

Description copied from interface: MessageBufferListener

Notification when the buffer at the relay peer is full. Use MessageBuffer#collectBuffer() to collect the messages

Specified by:

bufferFull in interface MessageBufferListener<Message>

Parameters:

messages - the messages that were buffered. Note that the buffer of MessageBuffer is cleared as soon as this method call has been set.

onBufferFull

public abstract void onBufferFull()

Called when the buffer is full and has been triggered. The messages in the buffer are kept in BufferedRelayServer.

bufferFlushed

public void bufferFlushed(List<Message> messages)

Description copied from interface: MessageBufferListener

Notification when the buffer at the relay peer has been flushed manually (using MessageBuffer.flushNow().

Specified by:

bufferFlushed in interface MessageBufferListener<Message>

Parameters:

messages - the messages that were buffered

collectBufferedMessages

public Buffer collectBufferedMessages()

Retrieves the messages that are ready to send. Ready to send means that they have been buffered and the Android device has already been notified.

Returns:

the buffer containing all buffered messages or null in case no message has been buffered

onBufferCollected

protected abstract void onBufferCollected()

Called when the buffer has been collected by the unreachable peer

peerMapUpdated

protected void peerMapUpdated(Message originalMessage,
                  Message preparedResponse)

Description copied from class: BaseRelayServer

Is called when the unreachable peer sent an update to the relay peer. This gives the server implementation the chance to extract further information from the original map update message or attach something to the response.

Specified by:

peerMapUpdated in class BaseRelayServer

Parameters:

originalMessage - the original message that contained the extracted peer map

bufferConfiguration

public MessageBufferConfiguration bufferConfiguration()

Get the buffer configuration. Note, changing the configuraton does not affect the behavior.