Public Member Functions | |
| Acknowledge () | |
| Acknowledges all consumed messages of the session of this consumed message. | |
Public Attributes | |
| TObject | Connection |
| |
| AnsiString | Content |
| The message content. | |
Standard JMS Headers | |
| string | JMSCorrelationID |
| Good consumes will add this header to any responses they send so that entire conversations can be correlated. | |
| 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 Destination 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. | |
| IPrimitiveMap | Properties |
| Provides access to the message properties (headers). | |
| string | TransactionID |
| The transaction id. | |
| TBTMessage::Acknowledge | ( | ) |
Acknowledges all consumed messages of the session of this consumed message.
All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS 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.
| JMSException | if the JMS provider fails to acknowledge the messages due to some internal error. | |
| IllegalStateException | if this method is called on a closed session. |
| TObject TBTMessage::Connection |
| AnsiString TBTMessage::Content |
The message content.
SetContent For writing
| 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.
JMSCorrelationID can hold one of the following:
If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.
SetCorrelationID For writing
| 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.
When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.
SetDestination For writing
| 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 JMS API does not define any form of notification of message expiration.
Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.
SetExpiration For writing
| TJMSDeliveryMode TBTMessage::JMSDeliveryMode |
Whether or not the message is persistent.
JMS providers set this field when a message is sent. This property can be used to change the value for a message that has been received.
SetJMSDeliveryMode For writing
| Integer TBTMessage::JMSPriority |
The message priority level.
The JMS 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 JMS 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.
todo doc STOMP note value from 0-9 (n.b. priorities aren't currently supported)
todo doc are priorities not supported only in STOMP or also in REST, Jabber?
DEFAULT_PRIORITY For writing
| Boolean TBTMessage::JMSRedelivered |
Redelivered - Returns 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.
SetJMSRedelivered For writing
| 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 Queue object or a Topic 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.
SetReplyTo For writing
| 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.
Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the MessageProducer.setDisableMessageTimestamp method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.
SetTimestamp For writing
| 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.
When a message is sent, JMSMessageID can be ignored. When the send or publish method returns, it contains a provider-assigned value.
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.
All JMSMessageID values must start with the prefix 'ID:'. Uniqueness of message ID values across different providers is not required.
Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the MessageProducer.setDisableMessageID method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.
SetMessageID For writing
| string TBTMessage::JMSType |
The type name of this message.
Some JMS 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 JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.
Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.
To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.
SetTypeName For writing
| IPrimitiveMap TBTMessage::Properties |
Provides access to the message properties (headers).
| string TBTMessage::TransactionID |
The transaction id.
FTransactionID For writing
