edu.umass.cs.nio

Class MessageNIOTransport<NodeIDType,MessageType>

java.lang.Object

edu.umass.cs.nio.NIOTransport<NodeIDType>

edu.umass.cs.nio.MessageNIOTransport<NodeIDType,MessageType>

Type Parameters:

NodeIDType -

MessageType - This class exists primarily as a wrapper around NIOTransport to support messages. NIOTransport is for general-purpose NIO byte stream communication between numbered nodes as specified by the NodeConfig interface and a data processing worker as specified by the DataProcessingWorker interface that handles a byte stream. This class provides the abstraction of messages and a corresponding PacketDemultiplexer that handles messages instead of a continuous byte stream. MessageType can be any type whose toString() method results in a meaningful serialization of a MessageType instance, i.e., the packet demultiplexer on the other end must be able to reconstruct the MessageType object from the String. The one exception is byte[] that is supported here. However, MessageType can not extend Object[] or be any primitive array other than byte[]. If byte[] is MessageType, the corresponding AbstractPacketDemultiplexer.getMessage(byte[]) method should return a String decoded from the byte[] assuming ISO-8859-1 encoding. This class short-circuits local sends by directly sending it to the packet demultiplexer.

All Implemented Interfaces:

AddressMessenger<MessageType>, HandshakeCallback, InterfaceNIOTransport<NodeIDType,MessageType>, java.lang.Runnable

Direct Known Subclasses:

JSONNIOTransport

public class MessageNIOTransport<NodeIDType,MessageType>
extends NIOTransport<NodeIDType>
implements InterfaceNIOTransport<NodeIDType,MessageType>

Author:

V. Arun

Nested Class Summary

Nested classes/interfaces inherited from class edu.umass.cs.nio.NIOTransport

NIOTransport.AlternatingByteBuffer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NIO_CHARSET_ENCODING We send even byte arrays encoded as strings because it is easier to do demultiplexing (in JSONMesageExtractor) working with strings than byte arrays.
static java.lang.String	RCVR_ADDRESS_FIELD JSON key corresponding to receiver socket address.
static java.lang.String	RCVR_IP_FIELD Deprecated.
static java.lang.String	RCVR_PORT_FIELD Deprecated.
static java.lang.String	SNDR_ADDRESS_FIELD JSON key corresponding to sender socket address.
static java.lang.String	SNDR_IP_FIELD Deprecated.
static java.lang.String	SNDR_PORT_FIELD Deprecated.

Fields inherited from class edu.umass.cs.nio.NIOTransport

DEFAULT_SSL_MODE, MAX_PAYLOAD_SIZE, MAX_QUEUED_SENDS, MIN_INTER_CONNECT_TIME, myID, nodeConfig, worker, WRITE_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
MessageNIOTransport(java.net.InetAddress address, int port, AbstractPacketDemultiplexer<?> pd, SSLDataProcessingWorker.SSL_MODES sslMode)
MessageNIOTransport(java.net.InetSocketAddress isa, NodeConfig<NodeIDType> nodeConfig, SSLDataProcessingWorker.SSL_MODES sslMode)
MessageNIOTransport(NodeIDType id, NodeConfig<NodeIDType> nodeConfig) Initiates transporter with id and nodeConfig.
MessageNIOTransport(NodeIDType id, NodeConfig<NodeIDType> nodeConfig, AbstractPacketDemultiplexer<?> pd, boolean start)
MessageNIOTransport(NodeIDType id, NodeConfig<NodeIDType> nodeConfig, AbstractPacketDemultiplexer<?> pd, boolean start, SSLDataProcessingWorker.SSL_MODES sslMode)
MessageNIOTransport(NodeIDType id, NodeConfig<NodeIDType> nodeConfig, SSLDataProcessingWorker.SSL_MODES sslMode)

Method Summary

Modifier and Type	Method and Description
void	addPacketDemultiplexer(AbstractPacketDemultiplexer<?> pd)
NodeIDType	getMyID()
NodeConfig<NodeIDType>	getNodeConfig()
static java.net.InetSocketAddress	getReceiverAddress(byte[] bytes)
static java.net.InetSocketAddress	getReceiverAddress(org.json.JSONObject json)
static java.net.InetSocketAddress	getReceiverAddressJSONSmart(net.minidev.json.JSONObject json)
static java.net.InetSocketAddress	getSenderAddress(byte[] bytes)
static java.net.InetSocketAddress	getSenderAddress(org.json.JSONObject json)
static java.lang.String	getSenderAddressAsString(org.json.JSONObject json)
static java.net.InetSocketAddress	getSenderAddressJSONSmart(net.minidev.json.JSONObject json)
static java.net.InetAddress	getSenderInetAddress(org.json.JSONObject json)
static void	main(java.lang.String[] args)
void	precedePacketDemultiplexer(AbstractPacketDemultiplexer<?> pd)
int	sendToAddress(java.net.InetSocketAddress isa, byte[] msg)
int	sendToAddress(java.net.InetSocketAddress isa, MessageType msg) Send a JSON packet to an inet socket address (ip and port).
int	sendToID(NodeIDType id, byte[] msg)
int	sendToID(NodeIDType id, MessageType msg) Send a JSON packet to a node id.
protected int	sendToIDInternal(NodeIDType destID, MessageType msg)
MessageNIOTransport<NodeIDType,MessageType>	setName(java.lang.String name)
void	stop() To close NIOTransport instances gracefully.

Methods inherited from class edu.umass.cs.nio.NIOTransport

cleanup, getCompression, getCompressionThreshold, getListeningAddress, getListeningPort, getListeningSocketAddress, getLogger, getNodeAddress, getNodePort, getPayloadLength, getPendingSize, getSSLMode, handshakeComplete, isDisconnected, isStarted, isStopped, outOfRange, run, send, send, send, setCompression, setCompressionThreshold, setMaxQueuedSends, setMinInterConnectTime, setUseSenderTask, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.umass.cs.nio.interfaces.InterfaceNIOTransport

getListeningSocketAddress, getSSLMode, isDisconnected, isStopped

Field Detail

SNDR_IP_FIELD

@Deprecated
public static final java.lang.String SNDR_IP_FIELD

Deprecated.

JSON key corresponding to sender IP address. Relevant only if MessageType is JSONObject. These can be optimized to have just a single short key, e.g., "SA" for sender socket address, but it doesn't really matter because all four fields below are stamped only at the receiver, so they don't induce more network traffic or (de-)serialization overhead.

See Also:

Constant Field Values

SNDR_PORT_FIELD

@Deprecated
public static final java.lang.String SNDR_PORT_FIELD

Deprecated.

JSON key corresponding to sender port number. Relevant only if MessageType is JSONObject.

See Also:

Constant Field Values

SNDR_ADDRESS_FIELD

public static final java.lang.String SNDR_ADDRESS_FIELD

JSON key corresponding to sender socket address. Relevant only if MessageType is JSONObject.

See Also:

Constant Field Values

RCVR_IP_FIELD

@Deprecated
public static final java.lang.String RCVR_IP_FIELD

Deprecated.

JSON key corresponding to receiver IP address. Relevant only if MessageType is JSONObject.

See Also:

Constant Field Values

RCVR_PORT_FIELD

@Deprecated
public static final java.lang.String RCVR_PORT_FIELD

Deprecated.

JSON key corresponding to receiver port number. Relevant only if MessageType is JSONObject.

See Also:

Constant Field Values

RCVR_ADDRESS_FIELD

public static final java.lang.String RCVR_ADDRESS_FIELD

JSON key corresponding to receiver socket address. Relevant only if MessageType is JSONObject.

See Also:

Constant Field Values

NIO_CHARSET_ENCODING

public static final java.lang.String NIO_CHARSET_ENCODING

We send even byte arrays encoded as strings because it is easier to do demultiplexing (in JSONMesageExtractor) working with strings than byte arrays. Using a fixed encoding only ensures that going from a string to bytes and back yields the same string. But we also want the property here that going from a byte array to a string and back yields the same byte array. This property is not ensured by all encodings but is ensured by ISO-8859-1, so we use that encoding. Note: If we really just need to send a byte stream and don't care about receiving all of the bytes written as a single unit, we should not be using MessageNIOTransport in the first place, and just use NIOTransport directly instead.

See Also:

Constant Field Values

Constructor Detail

MessageNIOTransport

public MessageNIOTransport(NodeIDType id,
                           NodeConfig<NodeIDType> nodeConfig)
                    throws java.io.IOException

Initiates transporter with id and nodeConfig.

Parameters:

id - My node ID.

nodeConfig - A map from all nodes' IDs to their respective socket addresses.

Throws:

java.io.IOException

MessageNIOTransport

public MessageNIOTransport(NodeIDType id,
                           NodeConfig<NodeIDType> nodeConfig,
                           SSLDataProcessingWorker.SSL_MODES sslMode)
                    throws java.io.IOException

Parameters:

id -

nodeConfig -

sslMode -

Throws:

java.io.IOException

MessageNIOTransport

public MessageNIOTransport(java.net.InetSocketAddress isa,
                           NodeConfig<NodeIDType> nodeConfig,
                           SSLDataProcessingWorker.SSL_MODES sslMode)
                    throws java.io.IOException

Parameters:

isa -

nodeConfig -

sslMode -

Throws:

java.io.IOException

MessageNIOTransport

public MessageNIOTransport(NodeIDType id,
                           NodeConfig<NodeIDType> nodeConfig,
                           AbstractPacketDemultiplexer<?> pd,
                           boolean start)
                    throws java.io.IOException

Parameters:

id - My node ID.

nodeConfig - A map from all nodes' IDs to their respective socket addresses.

pd - The packet demultiplexer to handle received messages.

start - If a server thread must be automatically started upon construction. If false, the caller must explicitly invoke (new Thread(JSONNIOTransport)).start() to start the server.

Throws:

java.io.IOException

MessageNIOTransport

public MessageNIOTransport(NodeIDType id,
                           NodeConfig<NodeIDType> nodeConfig,
                           AbstractPacketDemultiplexer<?> pd,
                           boolean start,
                           SSLDataProcessingWorker.SSL_MODES sslMode)
                    throws java.io.IOException

Parameters:

id -

nodeConfig -

pd -

start -

sslMode - To enable SSL.

Throws:

java.io.IOException

MessageNIOTransport

public MessageNIOTransport(java.net.InetAddress address,
                           int port,
                           AbstractPacketDemultiplexer<?> pd,
                           SSLDataProcessingWorker.SSL_MODES sslMode)
                    throws java.io.IOException

Parameters:

address -

port -

pd -

sslMode -

Throws:

java.io.IOException

Method Detail

addPacketDemultiplexer

public void addPacketDemultiplexer(AbstractPacketDemultiplexer<?> pd)

Specified by:

addPacketDemultiplexer in interface InterfaceNIOTransport<NodeIDType,MessageType>

Parameters:

pd - The demultiplxer to add at the end of the current chain.

precedePacketDemultiplexer

public void precedePacketDemultiplexer(AbstractPacketDemultiplexer<?> pd)

Specified by:

precedePacketDemultiplexer in interface InterfaceNIOTransport<NodeIDType,MessageType>

Parameters:

pd - The demultiplxer to add before the current chain.

getMyID

public NodeIDType getMyID()

Specified by:

getMyID in interface InterfaceNIOTransport<NodeIDType,MessageType>

Returns:

My node ID.

stop

public void stop()

Description copied from class: NIOTransport

To close NIOTransport instances gracefully.

Specified by:

stop in interface InterfaceNIOTransport<NodeIDType,MessageType>

Overrides:

stop in class NIOTransport<NodeIDType>

sendToID

public int sendToID(NodeIDType id,
                    MessageType msg)
             throws java.io.IOException

Send a JSON packet to a node id.

Specified by:

sendToID in interface InterfaceNIOTransport<NodeIDType,MessageType>

Parameters:

id -

msg -

Returns:

Refer JSONMessenger.sendToID(Object, JSONObject).

Throws:

java.io.IOException

sendToAddress

public int sendToAddress(java.net.InetSocketAddress isa,
                         MessageType msg)
                  throws java.io.IOException

Send a JSON packet to an inet socket address (ip and port).

Specified by:

sendToAddress in interface AddressMessenger<MessageType>

Specified by:

sendToAddress in interface InterfaceNIOTransport<NodeIDType,MessageType>

Parameters:

isa -

msg -

Returns:

Refer JSONMessenger.sendToID(Object, JSONObject).

Throws:

java.io.IOException

getSenderAddress

public static final java.net.InetSocketAddress getSenderAddress(org.json.JSONObject json)

Parameters:

json -

Returns:

Socket address of the sender recorded in this JSON message at receipt time.

getSenderAddressAsString

public static final java.lang.String getSenderAddressAsString(org.json.JSONObject json)

Parameters:

json -

Returns:

Sender address as String without intermediate conversion to InetSocketAddress.

getSenderAddress

public static final java.net.InetSocketAddress getSenderAddress(byte[] bytes)
                                                         throws java.net.UnknownHostException

Parameters:

bytes -

Returns:

Sender InetSocketAddress from bytes

Throws:

java.net.UnknownHostException

getReceiverAddress

public static final java.net.InetSocketAddress getReceiverAddress(byte[] bytes)
                                                           throws java.net.UnknownHostException

Parameters:

bytes -

Returns:

Sender InetSocketAddress from bytes

Throws:

java.net.UnknownHostException

getSenderAddressJSONSmart

public static final java.net.InetSocketAddress getSenderAddressJSONSmart(net.minidev.json.JSONObject json)

Parameters:

json -

Returns:

Parsed socket address

getReceiverAddress

public static final java.net.InetSocketAddress getReceiverAddress(org.json.JSONObject json)

Parameters:

json -

Returns:

Socket address of the recorded recorded in this JSON message at receipt time. Sometimes a sender needs to know on which of its possibly multiple listening sockets this message was received, so we insert it into the packet at receipt time.

getReceiverAddressJSONSmart

public static final java.net.InetSocketAddress getReceiverAddressJSONSmart(net.minidev.json.JSONObject json)

Parameters:

json -

Returns:

Same as getReceiverAddress(JSONObject)

getSenderInetAddress

public static final java.net.InetAddress getSenderInetAddress(org.json.JSONObject json)
                                                       throws org.json.JSONException

Parameters:

json -

Returns:

Sender InetAddress read from json.

Throws:

org.json.JSONException

sendToIDInternal

protected int sendToIDInternal(NodeIDType destID,
                               MessageType msg)
                        throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

getNodeConfig

public NodeConfig<NodeIDType> getNodeConfig()

Specified by:

getNodeConfig in interface InterfaceNIOTransport<NodeIDType,MessageType>

Returns:

Node config used by this NIO transport.

sendToID

public int sendToID(NodeIDType id,
                    byte[] msg)
             throws java.io.IOException

Specified by:

sendToID in interface InterfaceNIOTransport<NodeIDType,MessageType>

Returns:

Number of bytes written.

Throws:

java.io.IOException

sendToAddress

public int sendToAddress(java.net.InetSocketAddress isa,
                         byte[] msg)
                  throws java.io.IOException

Specified by:

sendToAddress in interface AddressMessenger<MessageType>

Specified by:

sendToAddress in interface InterfaceNIOTransport<NodeIDType,MessageType>

Returns:

Number of bytes written.

Throws:

java.io.IOException

setName

public MessageNIOTransport<NodeIDType,MessageType> setName(java.lang.String name)

Overrides:

setName in class NIOTransport<NodeIDType>

Returns:

this