Package org.sellcom.core.net

Class NetworkMessage

java.lang.Object

org.sellcom.core.net.NetworkMessage

public class NetworkMessage
extends java.lang.Object

Network message.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	HEADER_LENGTH	Length of the network message header (in bytes).

Method Summary

Modifier and Type	Method	Description
static NetworkMessage	create()	Creates an empty network message.
static NetworkMessage	fromByteBuffer(java.nio.ByteBuffer buffer, java.net.InetSocketAddress remoteEndPoint)	Creates a NetworkMessage from the given ByteBuffer containing the raw data.
byte[]	getPayload()	Returns the payload of this message.
java.net.InetAddress	getRemoteAddress()	Returns the address of the remote end point associated with this message.
java.net.InetSocketAddress	getRemoteEndPoint()	Returns the remote end point associated with this message.
java.lang.String	getRemoteHostName()	Returns the host name of the remote end point associated with this message.
java.lang.Integer	getRemotePort()	Returns the port of the remote end point associated with this message.
java.util.UUID	getUuid()	Returns the UUID of this message.
boolean	isValid()	Checks whether the message is valid.
java.nio.ByteBuffer	toByteBuffer()	Returns a ByteBuffer containing the raw data of this message.
NetworkMessage	withPayload(byte[] payload)	Sets the payload of this message.
NetworkMessage	withRandomUuid()	Sets the UUID of this message to a random value.
NetworkMessage	withRemoteEndPoint(java.net.InetSocketAddress remoteEndPoint)	Sets the remote end point associated with this message.
NetworkMessage	withUuid(java.util.UUID uuid)	Sets the UUID of this message.

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_LENGTH

public static final int HEADER_LENGTH

Length of the network message header (in bytes).

Since:

1.0

See Also:

Constant Field Values

Method Detail

create

public static NetworkMessage create()

Creates an empty network message.

Since:

1.0

fromByteBuffer

public static NetworkMessage fromByteBuffer(java.nio.ByteBuffer buffer,
                                            java.net.InetSocketAddress remoteEndPoint)
                                     throws java.io.IOException

Creates a NetworkMessage from the given ByteBuffer containing the raw data.

Throws:

java.lang.IllegalArgumentException - if buffer is null

java.lang.IllegalArgumentException - if remoteEndPoint is null

java.io.IOException

Since:

1.0

getPayload

public byte[] getPayload()

Returns the payload of this message.

Since:

1.0

getRemoteAddress

public java.net.InetAddress getRemoteAddress()

Returns the address of the remote end point associated with this message.

Since:

1.0

getRemoteEndPoint

public java.net.InetSocketAddress getRemoteEndPoint()

Returns the remote end point associated with this message.

Since:

1.0

getRemoteHostName

public java.lang.String getRemoteHostName()

Returns the host name of the remote end point associated with this message.

Since:

1.0

getRemotePort

public java.lang.Integer getRemotePort()

Returns the port of the remote end point associated with this message.

Since:

1.0

getUuid

public java.util.UUID getUuid()

Returns the UUID of this message.

Since:

1.0

isValid

public boolean isValid()

Checks whether the message is valid.

Since:

1.0

toByteBuffer

public java.nio.ByteBuffer toByteBuffer()

Returns a ByteBuffer containing the raw data of this message.

Throws:

java.lang.IllegalStateException - if the UUID has not yet been set

Since:

1.0

withPayload

public NetworkMessage withPayload(byte[] payload)

Sets the payload of this message.

Throws:

java.lang.IllegalArgumentException - if payload is null

Since:

1.0

withRandomUuid

public NetworkMessage withRandomUuid()

Sets the UUID of this message to a random value.

Since:

1.0

withRemoteEndPoint

public NetworkMessage withRemoteEndPoint(java.net.InetSocketAddress remoteEndPoint)

Sets the remote end point associated with this message.

Throws:

java.lang.IllegalArgumentException - if remoteEndPoint is null

java.lang.IllegalArgumentException - if remoteEndPoint.getPort() is 0

Since:

1.0

withUuid

public NetworkMessage withUuid(java.util.UUID uuid)

Sets the UUID of this message.

Throws:

java.lang.IllegalArgumentException - if uuid is null

Since:

1.0