com.bloomberg.bmq

Interface PushMessage

All Superinterfaces:

Event, QueueEvent

public interface PushMessage
extends QueueEvent

PUSH message representation.

PUSH mesage comes from the broker which sends it to the consumer if it is a subscriber of some Queue that has PutMessage posted by the producer.

Method Summary

Modifier and Type	Method and Description
ResultCodes.GenericResult	confirm() Sends CONFIRM message to the broker that affirms the receiving of this message.
MessageProperty	getProperty(String name) Returns property with specified (@code name).
boolean	hasMessageProperties() Returns true if the application data of this message contains message properties.
MessageGUID	messageGUID() Returns unique MessageGUID assigned to this message by the broker.
ByteBuffer[]	payload() Returns user payload data of this message.
Iterator<MessageProperty>	propertyIterator() Returns a standart Iterator to iterate over existed properties.

Methods inherited from interface com.bloomberg.bmq.QueueEvent

queue

Methods inherited from interface com.bloomberg.bmq.Event

session

Method Detail

messageGUID

MessageGUID messageGUID()

Returns unique MessageGUID assigned to this message by the broker.

Returns:

MessageGUID unique message GUID

hasMessageProperties

boolean hasMessageProperties()

Returns true if the application data of this message contains message properties.

Returns:

boolean true if the application data has message properties, false otherwise

See Also:

MessageProperty, MessageProperties

propertyIterator

Iterator<MessageProperty> propertyIterator()

Returns a standart Iterator to iterate over existed properties.

Returns:

Iterator property iterator

getProperty

MessageProperty getProperty(String name)

Returns property with specified (@code name).

Parameters:

name - property name

Returns:

(@code MessageProperty) if property with such name exists or (@code null).

payload

ByteBuffer[] payload()
              throws BMQException

Returns user payload data of this message.

Returns:

ByteBuffer[] array of byte buffers that represents the user payload

Throws:

BMQException - in case of any failure

confirm

ResultCodes.GenericResult confirm()

Sends CONFIRM message to the broker that affirms the receiving of this message.

Returns:

GenericResult status of the CONFIRM message sending

See Also:

ResultCodes.GenericResult