Habari Client for ActiveMQ 6.12
Object Pascal STOMP client library for Apache ActiveMQ
TBTMessage Class Reference

This object represents a message. More...

Inheritance diagram for TBTMessage:
TBTBytesMessage TBTMapMessage TBTObjectMessage TBTTextMessage

Public Member Functions

 Acknowledge ()
 Acknowledges all consumed messages of the session of this consumed message. More...
 
 Nack ()
 NACK is the opposite of ACK. More...
 
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.
 

Public Attributes

RawByteString Content
 The message content. More...
 
string StompSubscriptionID
 required for ACK in STOMP 1.1 More...
 
Standard Headers
string JMSCorrelationID
 Good consumes will add this header to any responses they send so that entire conversations can be correlated. More...
 
IDestination JMSDestination
 Gets the Destination object for this message. More...
 
TDateTime JMSExpiration
 The message's expiration value. More...
 
TJMSDeliveryMode JMSDeliveryMode
 Whether or not the message is persistent. More...
 
Integer JMSPriority
 The message priority level. More...
 
Boolean JMSRedelivered
 Redelivered - True if this message has been redelivered to this or another consumer before being acknowledged successfully. More...
 
IDestination JMSReplyTo
 The Destination object to which a reply to this message should be sent. More...
 
TDateTime JMSTimestamp
 The timestamp the broker added to the message. More...
 
string JMSMessageID
 The message ID which is set by the provider. More...
 
string JMSType
 The type name of this message. More...
 
string TransactionID
 The transaction id. More...
 

Detailed Description

This object represents a message.

Member Function Documentation

◆ Acknowledge()

TBTMessage::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
EJMSExceptionif the provider fails to acknowledge the messages due to some internal error.
IllegalStateExceptionif this method is called on a closed session.

◆ Nack()

TBTMessage::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.

Member Data Documentation

◆ Content

RawByteString TBTMessage::Content

The message content.

See also
FContent For reading

◆ JMSCorrelationID

string TBTMessage::JMSCorrelationID

Good consumes will add this header to any responses they send so that entire conversations can be correlated.

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 TBTMessage::JMSDeliveryMode

Whether or not the message is persistent.

Providers (servers) set this field when a message is sent.

See also
GetJMSDeliveryMode For reading
SetJMSDeliveryMode For writing

◆ JMSDestination

IDestination TBTMessage::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.

See also
GetDestination For reading
SetDestination For writing

◆ JMSExpiration

TDateTime TBTMessage::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.

When a message's expiration time is reached, a provider should discard it. The API does not define any form of notification of message expiration.

Clients should not receive messages that have expired; however, the API does not guarantee that this will not happen.

See also
GetExpiration For reading
SetExpiration For writing

◆ JMSMessageID

string TBTMessage::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.

A JMSMessageID is a String value that should function as a unique key for identifying messages in a historical repository. The exact scope of uniqueness is provider-defined. It should at least cover all messages for a specific installation of a provider, where an installation is some connected set of message routers.

Uniqueness of message ID values across different providers is not required.

See also
GetMessageID For reading
SetMessageID For writing

◆ JMSPriority

Integer TBTMessage::JMSPriority

The message priority level.

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

The minimum, maximum and default values are broker API dependent:

The API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

The API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

The possible values depend on broker and protocol version.

See also
GetPriority For reading
SetPriority For writing

◆ JMSRedelivered

Boolean TBTMessage::JMSRedelivered

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

An indication of whether this message is being redelivered.

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
GetJMSRedelivered For reading
SetJMSRedelivered For writing

◆ JMSReplyTo

IDestination TBTMessage::JMSReplyTo

The Destination 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.

Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

See also
GetReplyTo For reading
SetReplyTo For writing

◆ JMSTimestamp

TDateTime TBTMessage::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. The value is in the format of a normal millis time value in the Java programming language.

See also
GetTimestamp For reading
SetTimestamp For writing

◆ JMSType

string TBTMessage::JMSType

The type name of this message.

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.

The API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

See also
GetTypeName For reading
SetTypeName For writing

◆ StompSubscriptionID

string TBTMessage::StompSubscriptionID

required for ACK in STOMP 1.1

See also
FSubscriptionID For reading

◆ TransactionID

string TBTMessage::TransactionID

The transaction id.

See also
GetTransactionID For reading
SetTransactionID For writing