IMessage Interface Reference

Represents a message either to be sent to a message broker or received from a message broker. More...

Inheritance diagram for IMessage:

Public Member Functions
PMStrings	GetPropertyNames ()
	Returns a list of all the property names.
Boolean	GetBooleanProperty (const string Key)
	Get the value of boolean property Key.
	SetBooleanProperty (const string Key, const Boolean Value)
	Set the value of boolean property Key.
Integer	GetIntProperty (const string Key)
	Get the value of int property Key.
	SetIntProperty (const string Key, const Integer Value)
	Set the value of int property Key.
string	GetStringProperty (const string Key)
	Get the value of string property Key.
	SetStringProperty (const string Key, const string Value)
	Set the value of string property Key.
	Acknowledge ()
	Acknowledges all consumed messages of the session of this consumed message.
	Nack ()
	NACK is the opposite of ACK.

Public Attributes
string	JMSCorrelationID
	The correlation ID for the message.
IDestination	JMSDestination
	Gets the Destination object for this message.
TDateTime	JMSExpiration
	The message's expiration value.
TJMSDeliveryMode	JMSDeliveryMode
	Whether or not the message is persistent.
Integer	JMSPriority
	The message priority level.
Boolean	JMSRedelivered
	Redelivered - Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.
IDestination	JMSReplyTo
	The IDestination object to which a reply to this message should be sent.
TDateTime	JMSTimestamp
	The timestamp the broker added to the message.
string	JMSMessageID
	The message ID which is set by the provider.
string	JMSType
	The type name of this message.

Detailed Description

Represents a message either to be sent to a message broker or received from a message broker.

Member Function Documentation

Acknowledge()

IMessage::Acknowledge

(

)

Acknowledges all consumed messages of the session of this consumed message.

All consumed messages support the acknowledge method for use when a client has specified that its session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.

Exceptions

EMQException	if the provider fails to acknowledge the messages due to some internal error.
IllegalStateException	if this method is called on a closed session.

Implemented in TBTMessage.

GetBooleanProperty()

Boolean IMessage::GetBooleanProperty

(

const string

Key

)

Get the value of boolean property Key.

Implemented in TBTMessage.

GetIntProperty()

Integer IMessage::GetIntProperty

(

const string

Key

)

Get the value of int property Key.

Implemented in TBTMessage.

GetPropertyNames()

PMStrings IMessage::GetPropertyNames

(

)

Returns a list of all the property names.

Implemented in TBTMessage.

GetStringProperty()

string IMessage::GetStringProperty

(

const string

Key

)

Get the value of string property Key.

Implemented in TBTMessage.

Nack()

IMessage::Nack

(

)

NACK is the opposite of ACK.

It is used to tell the server that the client did not consume the message. The server can then either send the message to a different client, discard it, or put it in a dead letter queue. The exact behavior is server specific.

Implemented in TBTMessage.

SetBooleanProperty()

IMessage::SetBooleanProperty	(	const string	Key,
		const Boolean	Value )

Set the value of boolean property Key.

Implemented in TBTMessage.

SetIntProperty()

IMessage::SetIntProperty	(	const string	Key,
		const Integer	Value )

Set the value of int property Key.

Implemented in TBTMessage.

SetStringProperty()

IMessage::SetStringProperty	(	const string	Key,
		const string	Value )

Set the value of string property Key.

Implemented in TBTMessage.

Member Data Documentation

JMSCorrelationID

string IMessage::JMSCorrelationID

The correlation ID for the message.

A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

See also

GetCorrelationID For reading

SetCorrelationID For writing

JMSDeliveryMode

TJMSDeliveryMode IMessage::JMSDeliveryMode

Whether or not the message is persistent.

Message providers set this field when a message is sent.

See also

GetDeliveryMode For reading

SetDeliveryMode For writing

JMSDestination

IDestination IMessage::JMSDestination

Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

See also

GetDestination For reading

SetDestination For writing

JMSExpiration

TDateTime IMessage::JMSExpiration

The message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

See also

GetExpiration For reading

SetExpiration For writing

JMSMessageID

string IMessage::JMSMessageID

The message ID which is set by the provider.

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

Note

this header field is not supported by the STOMP specifications and STOMP-JMS bindings of supported brokers.

See also

GetMessageID For reading

SetMessageID For writing

JMSPriority

Integer IMessage::JMSPriority

The message priority level.

The API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest.

The API does not require that a provider strictly implements priority ordering of messages.

Providers set this field when a message is sent. To send a message with a priority, use the IMessageProducer's Priority property.

See also

GetPriority For reading

SetPriority For writing

JMSRedelivered

Boolean IMessage::JMSRedelivered

Redelivered - Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.

If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

See also

GetRedelivered For reading

SetRedelivered For writing

JMSReplyTo

IDestination IMessage::JMSReplyTo

The IDestination object to which a reply to this message should be sent.

The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a IQueue object or a ITopic object.

See also

GetReplyTo For reading

SetReplyTo For writing

JMSTimestamp

TDateTime IMessage::JMSTimestamp

The timestamp the broker added to the message.

The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return.

Note

this header field is not supported by the STOMP specifications and STOMP-JMS bindings of supported brokers.

See also

GetTimestamp For reading

SetTimestamp For writing

JMSType

string IMessage::JMSType

The type name of this message.

Note

Some providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

See also

GetTypeName For reading

SetTypeName For writing