org.mpisws.p2p.transport.commonapi
Class CommonAPITransportLayerImpl<Identifier extends NodeHandle>

java.lang.Object
  org.mpisws.p2p.transport.commonapi.CommonAPITransportLayerImpl<Identifier>

All Implemented Interfaces:

CommonAPITransportLayer<Identifier>, TransportLayer<Identifier,RawMessage>, TransportLayerCallback<Identifier,java.nio.ByteBuffer>, Destructable

public class CommonAPITransportLayerImpl<Identifier extends NodeHandle>
extends java.lang.Object
implements CommonAPITransportLayer<Identifier>, TransportLayerCallback<Identifier,java.nio.ByteBuffer>

Field Summary

static java.lang.String	DESTINATION_IDENTITY
protected boolean	destroyed
static java.lang.String	MSG_STRING

Constructor Summary

CommonAPITransportLayerImpl(TransportLayer<Identifier,java.nio.ByteBuffer> tl, IdFactory idFactory, RawMessageDeserializer deserializer, ErrorHandler errorHandler, Environment env)

Method Summary

void	acceptMessages(boolean b) Toggle accepting incoming messages.
void	acceptSockets(boolean b) Toggle accepting new sockets.
void	destroy()
Identifier	getLocalIdentifier() The local node.
void	incomingSocket(P2PSocket<Identifier> s) Notification of a new socket.
void	messageReceived(Identifier i, java.nio.ByteBuffer m, java.util.Map<java.lang.String,java.lang.Object> options) Called when a new message is received.
SocketRequestHandle<Identifier>	openSocket(Identifier i, SocketCallback<Identifier> deliverSocketToMe, java.util.Map<java.lang.String,java.lang.Object> options) Open a socket to the Identifier
MessageRequestHandle<Identifier,RawMessage>	sendMessage(Identifier i, RawMessage m, MessageCallback<Identifier,RawMessage> deliverAckToMe, java.util.Map<java.lang.String,java.lang.Object> options) Send the message to the identifier
void	setCallback(TransportLayerCallback<Identifier,RawMessage> callback) Set the callback for incoming sockets/messages
void	setErrorHandler(ErrorHandler<Identifier> handler) To be notified of problems not related to an outgoing messaage/socket.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_STRING

public static final java.lang.String MSG_STRING

See Also:

Constant Field Values

DESTINATION_IDENTITY

public static final java.lang.String DESTINATION_IDENTITY

See Also:

Constant Field Values

destroyed

protected boolean destroyed

Constructor Detail

CommonAPITransportLayerImpl

public CommonAPITransportLayerImpl(TransportLayer<Identifier,java.nio.ByteBuffer> tl,
                                   IdFactory idFactory,
                                   RawMessageDeserializer deserializer,
                                   ErrorHandler errorHandler,
                                   Environment env)

Method Detail

acceptMessages

public void acceptMessages(boolean b)

Description copied from interface: TransportLayer

Toggle accepting incoming messages. Useful in flow control if overwhelmed by incoming sockets. Default: true

Specified by:

acceptMessages in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

acceptSockets

public void acceptSockets(boolean b)

Description copied from interface: TransportLayer

Toggle accepting new sockets. Useful in flow control if overwhelmed by incoming sockets. Default: true

Specified by:

acceptSockets in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

getLocalIdentifier

public Identifier getLocalIdentifier()

Description copied from interface: TransportLayer

The local node.

Specified by:

getLocalIdentifier in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

Returns:

The local node.

sendMessage

public MessageRequestHandle<Identifier,RawMessage> sendMessage(Identifier i,
                                                               RawMessage m,
                                                               MessageCallback<Identifier,RawMessage> deliverAckToMe,
                                                               java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: TransportLayer

Send the message to the identifier

Specified by:

sendMessage in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

Parameters:

i - the destination

m - the message

deliverAckToMe - layer dependent notification when the message is sent (can indicate placed on the wire, point-to-point acknowledgement, or end-to-end acknowledgement)

options - delivery options (don't source route, encrypt etc) (may not be respected if layer cannot provide service)

Returns:

ability to cancel the message if no longer relevent

messageReceived

public void messageReceived(Identifier i,
                            java.nio.ByteBuffer m,
                            java.util.Map<java.lang.String,java.lang.Object> options)
                     throws java.io.IOException

Description copied from interface: TransportLayerCallback

Called when a new message is received.

Specified by:

messageReceived in interface TransportLayerCallback<Identifier extends NodeHandle,java.nio.ByteBuffer>

Parameters:

i - The node it is coming from

m - the message

options - describe how the message arrived (udp/tcp, encrypted etc)

Throws:

java.io.IOException - if there is a problem decoding the message

setCallback

public void setCallback(TransportLayerCallback<Identifier,RawMessage> callback)

Description copied from interface: TransportLayer

Set the callback for incoming sockets/messages

Specified by:

setCallback in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

Parameters:

callback - the callback for incoming sockets/messages

setErrorHandler

public void setErrorHandler(ErrorHandler<Identifier> handler)

Description copied from interface: TransportLayer

To be notified of problems not related to an outgoing messaage/socket. Or to be notified if a callback isn't provided.

Specified by:

setErrorHandler in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

Parameters:

handler - to be notified of problems not related to a specific messaage/socket.

destroy

public void destroy()

Specified by:

destroy in interface Destructable

openSocket

public SocketRequestHandle<Identifier> openSocket(Identifier i,
                                                  SocketCallback<Identifier> deliverSocketToMe,
                                                  java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: TransportLayer

Open a socket to the Identifier

Specified by:

openSocket in interface TransportLayer<Identifier extends NodeHandle,RawMessage>

Parameters:

i - who to open the socket to

deliverSocketToMe - the callback when the socket is opened

options - options on how to open the socket (don't source route, encrypt etc) (may not be respected if layer cannot provide service)

Returns:

an object to cancel opening the socket if it takes to long, or is no longer relevent

incomingSocket

public void incomingSocket(P2PSocket<Identifier> s)
                    throws java.io.IOException

Description copied from interface: TransportLayerCallback

Notification of a new socket.

Specified by:

incomingSocket in interface TransportLayerCallback<Identifier extends NodeHandle,java.nio.ByteBuffer>

Parameters:

s - the incoming socket

Throws:

java.io.IOException