org.mpisws.p2p.transport.bandwidthmeasure
Class BandwidthMeasuringTransportLayer<Identifier>

java.lang.Object
  org.mpisws.p2p.transport.bandwidthmeasure.BandwidthMeasuringTransportLayer<Identifier>

Type Parameters:

Identifier -

All Implemented Interfaces:

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

public class BandwidthMeasuringTransportLayer<Identifier>
extends java.lang.Object
implements TransportLayer<Identifier,java.nio.ByteBuffer>, TransportLayerCallback<Identifier,java.nio.ByteBuffer>

Measure the bandwidth of the connections.

Author:

Jeff Hoye

Field Summary

static int	CUR_DOWN
static int	CUR_SATURATED
static int	CUR_UP
static int	LAST_DOWN
static int	LAST_SATURATED
static int	LAST_UP
static int	NOT_SATURATED
static int	NUM_VALS
static int	SATURATED
protected TimeSource	time

Constructor Summary

BandwidthMeasuringTransportLayer(int measurementPeriod, TransportLayer<Identifier,java.nio.ByteBuffer> tl, Environment env)

Method Summary

void	acceptMessages(boolean b) Toggle accepting incoming messages.
void	acceptSockets(boolean b) Toggle accepting new sockets.
void	destroy()
java.util.Map<Identifier,Tuple3<java.lang.Integer,java.lang.Integer,java.lang.Boolean>>	getBandwidthUsed() For all Identifiers that used any bandwidth since the measurementPeriod, returns: downstream bytes/sec, upstream bytes/sec, if the upstream was saturated
Identifier	getLocalIdentifier() The local node.
Tuple<int[],java.util.Collection<org.mpisws.p2p.transport.bandwidthmeasure.BandwidthMeasuringTransportLayer.MySocket>>	getVals(Identifier i) Should be holding the lock on measured
void	incomingSocket(P2PSocket<Identifier> s) Notification of a new socket.
protected void	measure()
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,java.nio.ByteBuffer>	sendMessage(Identifier i, java.nio.ByteBuffer m, MessageCallback<Identifier,java.nio.ByteBuffer> deliverAckToMe, java.util.Map<java.lang.String,java.lang.Object> options) Send the message to the identifier
void	setCallback(TransportLayerCallback<Identifier,java.nio.ByteBuffer> 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

CUR_DOWN

public static final int CUR_DOWN

See Also:

Constant Field Values

CUR_UP

public static final int CUR_UP

See Also:

Constant Field Values

CUR_SATURATED

public static final int CUR_SATURATED

See Also:

Constant Field Values

LAST_DOWN

public static final int LAST_DOWN

See Also:

Constant Field Values

LAST_UP

public static final int LAST_UP

See Also:

Constant Field Values

LAST_SATURATED

public static final int LAST_SATURATED

See Also:

Constant Field Values

NUM_VALS

public static final int NUM_VALS

See Also:

Constant Field Values

SATURATED

public static final int SATURATED

See Also:

Constant Field Values

NOT_SATURATED

public static final int NOT_SATURATED

See Also:

Constant Field Values

time

protected TimeSource time

Constructor Detail

BandwidthMeasuringTransportLayer

public BandwidthMeasuringTransportLayer(int measurementPeriod,
                                        TransportLayer<Identifier,java.nio.ByteBuffer> tl,
                                        Environment env)

Method Detail

measure

protected void measure()

getVals

public Tuple<int[],java.util.Collection<org.mpisws.p2p.transport.bandwidthmeasure.BandwidthMeasuringTransportLayer.MySocket>> getVals(Identifier i)

Should be holding the lock on measured

Parameters:

i -

Returns:

getBandwidthUsed

public java.util.Map<Identifier,Tuple3<java.lang.Integer,java.lang.Integer,java.lang.Boolean>> getBandwidthUsed()

For all Identifiers that used any bandwidth since the measurementPeriod, returns: downstream bytes/sec, upstream bytes/sec, if the upstream was saturated

Returns:

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,java.nio.ByteBuffer>

Parameters:

s - the incoming socket

Throws:

java.io.IOException

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

sendMessage

public MessageRequestHandle<Identifier,java.nio.ByteBuffer> sendMessage(Identifier i,
                                                                        java.nio.ByteBuffer m,
                                                                        MessageCallback<Identifier,java.nio.ByteBuffer> 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,java.nio.ByteBuffer>

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

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,java.nio.ByteBuffer>

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

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,java.nio.ByteBuffer>

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,java.nio.ByteBuffer>

getLocalIdentifier

public Identifier getLocalIdentifier()

Description copied from interface: TransportLayer

The local node.

Specified by:

getLocalIdentifier in interface TransportLayer<Identifier,java.nio.ByteBuffer>

Returns:

The local node.

setCallback

public void setCallback(TransportLayerCallback<Identifier,java.nio.ByteBuffer> callback)

Description copied from interface: TransportLayer

Set the callback for incoming sockets/messages

Specified by:

setCallback in interface TransportLayer<Identifier,java.nio.ByteBuffer>

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,java.nio.ByteBuffer>

Parameters:

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

destroy

public void destroy()

Specified by:

destroy in interface Destructable