com.bloomberg.bmq

Interface PutMessage

All Superinterfaces:

Event, QueueEvent

public interface PutMessage
extends QueueEvent

PUT message representation.

Method Summary

Modifier and Type	Method and Description
CorrelationId	correlationId() Get correlation Id of the message
MessageProperties	messageProperties() Get reference to the message properties object.
Queue	queue() Returns an interface to the queue that this message is related to.
void	setCompressionAlgorithm(CompressionAlgorithm algorithm) Sets message payload compression algorithm.
CorrelationId	setCorrelationId() Sets and returns a new CorrelationId that contains an auto-assigned integer value starting from 1 and up to 0xFFFFFF.
CorrelationId	setCorrelationId(Object obj) Sets and returns a new CorrelationId that binds an auto-assigned integer value starting from 1 and up to 0xFFFFFF and the user specified Object.

Methods inherited from interface com.bloomberg.bmq.Event

session

Method Detail

setCorrelationId

CorrelationId setCorrelationId()

Sets and returns a new CorrelationId that contains an auto-assigned integer value starting from 1 and up to 0xFFFFFF.

Returns:

CorrelationId auto-generated correlation ID unique within process

setCorrelationId

CorrelationId setCorrelationId(Object obj)

Sets and returns a new CorrelationId that binds an auto-assigned integer value starting from 1 and up to 0xFFFFFF and the user specified Object. The user can expect that a valid CorrelationId provided to the PutMessage and the CorrelationId obtained from the corresponding AckMessage will hold the same Object available via CorrelationId.userData() accessor.

Parameters:

obj - user specified object

Returns:

CorrelationId auto-generated correlation ID that stores the user specified object

correlationId

CorrelationId correlationId()

Get correlation Id of the message

Returns:

correlation Id

messageProperties

MessageProperties messageProperties()

Get reference to the message properties object.

Returns:

MessageProperties

queue

Queue queue()

Returns an interface to the queue that this message is related to.

Specified by:

queue in interface QueueEvent

Returns:

Queue queue interface

setCompressionAlgorithm

void setCompressionAlgorithm(CompressionAlgorithm algorithm)

Sets message payload compression algorithm. See CompressionAlgorithm for available options

Parameters:

algorithm - payload compression algorithm