rsb.transport.spread

Class DataMessage

java.lang.Object

rsb.transport.spread.DataMessage

public class DataMessage
extends Object

Encapsulates a message containing data to be sent via spread.

Author:

swrede

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_MESSAGE_LENGTH Maximum length in bytes of messages that can be sent via spread.

Constructor Summary

Constructors

Constructor and Description
DataMessage()

Method Summary

Methods

Modifier and Type	Method and Description
void	addGroup(String group) Adds a group this message should be sent to.
void	enableSelfDiscard() Sets the self discard flag for this message so that it will not be delivered to the sender by the spread daemon.
ByteBuffer	getData() Returns the data this message will contain.
Set<String>	getGroups() Returns the spread groups this message will be sent to.
spread.SpreadMessage	getSpreadMessage() Returns the constructed SpreadMessage instance.
boolean	isForGroup(String name) Tells whether this message shall be sent to the requested group.
void	setData(byte[] buffer) Sets the data to send with this message.
void	setData(ByteBuffer buffer) Sets the data to send with this message.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_MESSAGE_LENGTH

public static final int MAX_MESSAGE_LENGTH

Maximum length in bytes of messages that can be sent via spread.

See Also:

Constant Field Values

Constructor Detail

DataMessage

public DataMessage()

Method Detail

getGroups

public Set<String> getGroups()

Returns the spread groups this message will be sent to.

Returns:

array of group names

addGroup

public void addGroup(String group)

Adds a group this message should be sent to.

Parameters:

group - the new group

Throws:

IllegalArgumentException - group name is null, empty, or longer then SpreadUtilities.MAX_GROUP_NAME_LENGTH

isForGroup

public boolean isForGroup(String name)

Tells whether this message shall be sent to the requested group.

Parameters:

name - name of the group to test for

Returns:

true if this message will be sent to that group

setData

public void setData(ByteBuffer buffer)
             throws SerializeException

Sets the data to send with this message.

Parameters:

buffer - data buffer, not null

Throws:

SerializeException - buffer cannot be serialized

setData

public void setData(byte[] buffer)
             throws SerializeException

Sets the data to send with this message.

Parameters:

buffer - data buffer, not null

Throws:

SerializeException - buffer cannot be serialized

getData

public ByteBuffer getData()

Returns the data this message will contain.

Returns:

byte buffer instance, not null

enableSelfDiscard

public void enableSelfDiscard()

Sets the self discard flag for this message so that it will not be delivered to the sender by the spread daemon.

getSpreadMessage

public spread.SpreadMessage getSpreadMessage()
                                      throws SerializeException

Returns the constructed SpreadMessage instance.

Returns:

constructed instance

Throws:

SerializeException - message cannot be created because information is missing