com.thomsonreuters.upa.valueadd.domainrep.rdm.queue

Interface QueueData

All Superinterfaces:

MsgBase, QueueMsg

public interface QueueData
extends QueueMsg

The queue data message.

Method Summary

Modifier and Type	Method and Description
boolean	checkPossibleDuplicate() Checks if possible duplicate flag is set.
int	containerType() Returns the container type of the queue data message.
void	containerType(int containerType) Sets the container type of the queue data message.
com.thomsonreuters.upa.codec.Buffer	destName() Returns the destination name of the remote message receiver.
void	destName(com.thomsonreuters.upa.codec.Buffer destName) Sets the destination name of the remote message receiver.
int	encodeComplete(com.thomsonreuters.upa.codec.EncodeIterator eIter, boolean success) Complete the encoding of a queue data message.
com.thomsonreuters.upa.codec.Buffer	encodedDataBody() Returns the encoded data body of the queue data message.
void	encodedDataBody(com.thomsonreuters.upa.codec.Buffer data) Sets the encoded data body of the queue data message.
int	encodeInit(com.thomsonreuters.upa.codec.EncodeIterator eIter) Initialize the encoding of a queue data message.
int	flags() Returns the flags of the queue data message.
void	flags(int flags) Sets the flags of the queue data message.
long	identifier() Returns the identifier of the queue data message.
void	identifier(long identifier) Sets the identifier of the queue data message.
int	queueDepth() Returns the number of messages remaining in the queue for this stream.
void	queueDepth(int queueDepth) Sets the number of messages remaining in the queue for this stream.
com.thomsonreuters.upa.codec.Buffer	sourceName() Returns the source name of the local message sender.
void	sourceName(com.thomsonreuters.upa.codec.Buffer sourceName) Sets the source name of the queue data message.
long	timeout() Returns the timeout (in milliseconds) at which the message should expire instead of being delivered.
void	timeout(long timeoutMsec) Sets the timeout (in milliseconds) at which the message should expire instead of being delivered.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.queue.QueueMsg

domainType, rdmMsgType, serviceId, serviceId

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.MsgBase

clear, decode, domainType, encode, streamId, streamId

Method Detail

sourceName

com.thomsonreuters.upa.codec.Buffer sourceName()

Returns the source name of the local message sender. Use to retrieve and set the source name.

Returns:

the buffer

sourceName

void sourceName(com.thomsonreuters.upa.codec.Buffer sourceName)

Sets the source name of the queue data message.

Parameters:

sourceName - the source name

destName

com.thomsonreuters.upa.codec.Buffer destName()

Returns the destination name of the remote message receiver. Use to retrieve and set the destination name.

Returns:

the buffer

destName

void destName(com.thomsonreuters.upa.codec.Buffer destName)

Sets the destination name of the remote message receiver.

Parameters:

destName - the dest name

identifier

void identifier(long identifier)

Sets the identifier of the queue data message.

Parameters:

identifier - the identifier

identifier

long identifier()

Returns the identifier of the queue data message.

Returns:

the long

timeout

void timeout(long timeoutMsec)

Sets the timeout (in milliseconds) at which the message should expire instead of being delivered. Can also be set to QueueDataTimeoutCode.IMMEDIATE or QueueDataTimeoutCode.INFINITE.

Parameters:

timeoutMsec - the timeout msec

See Also:

QueueDataTimeoutCode

timeout

long timeout()

Returns the timeout (in milliseconds) at which the message should expire instead of being delivered. Can also be set to QueueDataTimeoutCode.IMMEDIATE or QueueDataTimeoutCode.INFINITE.

Returns:

the long

See Also:

QueueDataTimeoutCode

queueDepth

void queueDepth(int queueDepth)

Sets the number of messages remaining in the queue for this stream.

Parameters:

queueDepth - the queue depth

queueDepth

int queueDepth()

Returns the number of messages remaining in the queue for this stream.

Returns:

the int

encodeInit

int encodeInit(com.thomsonreuters.upa.codec.EncodeIterator eIter)

Initialize the encoding of a queue data message. This is to be done before encoding any message payload.

Parameters:

eIter - The Encode Iterator

Returns:

UPA return value

encodeComplete

int encodeComplete(com.thomsonreuters.upa.codec.EncodeIterator eIter,
                   boolean success)

Complete the encoding of a queue data message. This is to be done after encoding any message payload.

Parameters:

eIter - The Encode Iterator

success - If true - successfully complete the message, if false - remove the message from the buffer.

Returns:

UPA return value

encodedDataBody

void encodedDataBody(com.thomsonreuters.upa.codec.Buffer data)

Sets the encoded data body of the queue data message.

Parameters:

data - the data

encodedDataBody

com.thomsonreuters.upa.codec.Buffer encodedDataBody()

Returns the encoded data body of the queue data message.

Returns:

the buffer

containerType

void containerType(int containerType)

Sets the container type of the queue data message.

Parameters:

containerType - the container type

containerType

int containerType()

Returns the container type of the queue data message.

Returns:

the int

flags

void flags(int flags)

Sets the flags of the queue data message.

Parameters:

flags - the flags

See Also:

QueueDataFlags

flags

int flags()

Returns the flags of the queue data message.

Returns:

the int

See Also:

QueueDataFlags

checkPossibleDuplicate

boolean checkPossibleDuplicate()

Checks if possible duplicate flag is set.

Returns:

true - if possible duplicate is set, false - if not.