org.mpisws.p2p.transport.nat
Class FirewallTLImpl<Identifier,MessageType>

java.lang.Object
  org.mpisws.p2p.transport.nat.FirewallTLImpl<Identifier,MessageType>

Type Parameters:

Identifier -

MessageType -

All Implemented Interfaces:

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

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

Drops all incoming TCP connections. Drops all incoming UDP connections that we didn't initiate, or that are since UDP_OPEN_MILLIS

Author:

Jeff Hoye

Field Summary

protected TransportLayerCallback<Identifier,MessageType>	callback
protected Environment	environment
protected Logger	logger
protected TimeSource	timeSource
protected TransportLayer<Identifier,MessageType>	tl
protected int	UDP_OPEN_MILLIS
protected java.util.Map<Identifier,java.lang.Long>	udpTable Holds when we last refreshed the UDP connection

Constructor Summary

FirewallTLImpl(TransportLayer<Identifier,MessageType> tl, int udp_open_millis, 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) Only allow outgoing sockets.
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

UDP_OPEN_MILLIS

protected final int UDP_OPEN_MILLIS

udpTable

protected java.util.Map<Identifier,java.lang.Long> udpTable

Holds when we last refreshed the UDP connection

tl

protected TransportLayer<Identifier,MessageType> tl

callback

protected TransportLayerCallback<Identifier,MessageType> callback

timeSource

protected TimeSource timeSource

environment

protected Environment environment

logger

protected Logger logger

Constructor Detail

FirewallTLImpl

public FirewallTLImpl(TransportLayer<Identifier,MessageType> tl,
                      int udp_open_millis,
                      Environment env)

Parameters:

tl -

udp_open_millis - how long the udp hole remains open

Method Detail

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

incomingSocket

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

Only allow outgoing sockets.

Specified by:

incomingSocket in interface TransportLayerCallback<Identifier,MessageType>

Parameters:

s - the incoming socket

Throws:

java.io.IOException

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 relevent

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