org.mpisws.p2p.transport.simpleidentity
Class SimpleIdentityTransportLayer<Identifier,MessageType>

java.lang.Object
  org.mpisws.p2p.transport.simpleidentity.SimpleIdentityTransportLayer<Identifier,MessageType>

Type Parameters:

Identifier -

MessageType -

All Implemented Interfaces:

TransportLayer<Identifier,MessageType>, TransportLayerCallback<Identifier,MessageType>, Destructable

public class SimpleIdentityTransportLayer<Identifier,MessageType>
extends java.lang.Object
implements TransportLayer<Identifier,MessageType>, TransportLayerCallback<Identifier,MessageType>

The purpose of this layer is to identify the opener of a TCP connection, because the socket is using an ephemeral port.

Author:

Jeff Hoye

Field Summary

protected ErrorHandler<Identifier>	errorHandler
protected Logger	logger
protected Serializer<Identifier>	serializer
protected TransportLayer<Identifier,MessageType>	tl

Constructor Summary

SimpleIdentityTransportLayer(TransportLayer<Identifier,MessageType> tl, Serializer<Identifier> serializer, LocalIdentifierStrategy<Identifier> localIdStrategy, Environment env, ErrorHandler<Identifier> handler)

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, MessageType 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,MessageType>	sendMessage(Identifier i, MessageType m, MessageCallback<Identifier,MessageType> deliverAckToMe, java.util.Map<java.lang.String,java.lang.Object> options) Send the message to the identifier
void	setCallback(TransportLayerCallback<Identifier,MessageType> 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

tl

protected TransportLayer<Identifier,MessageType> tl

logger

protected Logger logger

errorHandler

protected ErrorHandler<Identifier> errorHandler

serializer

protected Serializer<Identifier> serializer

Constructor Detail

SimpleIdentityTransportLayer

public SimpleIdentityTransportLayer(TransportLayer<Identifier,MessageType> tl,
                                    Serializer<Identifier> serializer,
                                    LocalIdentifierStrategy<Identifier> localIdStrategy,
                                    Environment env,
                                    ErrorHandler<Identifier> handler)
                             throws java.io.IOException

Throws:

java.io.IOException

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,MessageType>

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,MessageType>

getLocalIdentifier

public Identifier getLocalIdentifier()

Description copied from interface: TransportLayer

The local node.

Specified by:

getLocalIdentifier in interface TransportLayer<Identifier,MessageType>

Returns:

The local node.

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,MessageType>

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 relevant

sendMessage

public MessageRequestHandle<Identifier,MessageType> sendMessage(Identifier i,
                                                                MessageType m,
                                                                MessageCallback<Identifier,MessageType> 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,MessageType>

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 acknowledgment, 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 relevant

setCallback

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

Description copied from interface: TransportLayer

Set the callback for incoming sockets/messages

Specified by:

setCallback in interface TransportLayer<Identifier,MessageType>

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,MessageType>

Parameters:

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

destroy

public void destroy()

Specified by:

destroy in interface Destructable

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,MessageType>

Parameters:

s - the incoming socket

Throws:

java.io.IOException

messageReceived

public void messageReceived(Identifier i,
                            MessageType 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,MessageType>

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