![]() |
Habari STOMP Client for RabbitMQ 10.3-RC1
Object Pascal STOMP client library for RabbitMQ
|
Represents a message either to be sent to a message broker or received from a message broker. More...
Public Member Functions | |
| PMStrings | GetPropertyNames () |
| Returns a list of all the property names. | |
| 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. | |
| TBTMessage (const TBTStompClient ATransport) | |
| Constructor. | |
| TBTMessage (const TBTStompClient ATransport, const string ASubscriptionID) | |
| Constructor. | |
| TBTMessage (const TBTStompClient ATransport, const RawByteString AContent, const string ASubscriptionID) | |
| Constructor. | |
| ~TBTMessage () | |
Public Attributes | |
| string | CorrelationID |
| IDestination | Destination |
| TDateTime | Expiration |
| TDeliveryMode | DeliveryMode |
| Integer | Priority |
| Boolean | Redelivered |
| IDestination | ReplyTo |
| TDateTime | Timestamp |
| string | MessageID |
| string | JMSType |
| string | TransactionID |
| RawByteString | Content |
| The message content. | |
| string | StompSubscriptionID |
| required for ACK in STOMP 1.1 | |
| Public Attributes inherited from IMessage | |
| string | CorrelationID |
| The correlation ID for the message. | |
| IDestination | Destination |
| Gets the Destination object for this message. | |
| TDateTime | Expiration |
| The message's expiration value. | |
| TDeliveryMode | DeliveryMode |
| Whether or not the message is persistent. | |
| Integer | Priority |
| The message priority level. | |
| Boolean | Redelivered |
| Redelivered - Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully. | |
| IDestination | ReplyTo |
| The IDestination object to which a reply to this message should be sent. | |
| TDateTime | Timestamp |
| The timestamp the broker added to the message. | |
| string | MessageID |
| The message id which is set by the provider. | |
| string | JMSType |
| The type name of this message. | |
Protected Member Functions | |
| SetNackHeaders (const TStrings Value) | |
| string | GetTransactionID () |
| SetTransactionID (const string Value) | |
| string | GetSubscriptionID () |
| string | GetMsgID () |
| RawByteString | GetContent () |
| SetContent (const RawByteString Value) | |
| Acknowledge () | |
| Acknowledges this message by sending a STOMP ACK frame for the subscription that received it. | |
| Nack () | |
| NACK is the opposite of ACK. | |
| 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. | |
Represents a message either to be sent to a message broker or received from a message broker.
| TBTMessage::TBTMessage | ( | const TBTStompClient | ATransport | ) |
Constructor.
| TBTMessage::TBTMessage | ( | const TBTStompClient | ATransport, |
| const string | ASubscriptionID ) |
Constructor.
| TBTMessage::TBTMessage | ( | const TBTStompClient | ATransport, |
| const RawByteString | AContent, | ||
| const string | ASubscriptionID ) |
Constructor.
| TBTMessage::~TBTMessage | ( | ) |
|
protected |
Acknowledges this message by sending a STOMP ACK frame for the subscription that received it.
The scope depends on the acknowledgement mode of the session:
amClientAcknowledge (STOMP client): the broker treats the ACK cumulatively for the subscription that received the message, so the message and all messages received earlier on that subscription are acknowledged. Messages of other consumers in the same session are not affected. This differs from JMS, where acknowledging covers all messages consumed by the session.amClientIndividual (STOMP client-individual): only this message is acknowledged.amAutoAcknowledge: the broker has already considered the message acknowledged; calling this method is unnecessary.In a transacted session the ACK carries the session's transaction id, so it becomes part of the transaction on brokers that support transactional acknowledgement.
Messages that have been received but not acknowledged may be redelivered.
| EMQException | if the ACK frame cannot be sent. |
Implements IMessage.
|
protected |
Get the value of boolean property Key.
Implements IMessage.
|
protected |
|
protected |
Get the value of int property Key.
Implements IMessage.
|
protected |
| PMStrings TBTMessage::GetPropertyNames | ( | ) |
Returns a list of all the property names.
Implements IMessage.
| string TBTMessage::GetStringProperty | ( | const string | Key | ) |
Get the value of string property Key.
Implements IMessage.
|
protected |
|
protected |
|
protected |
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.
Implements IMessage.
|
protected |
Set the value of boolean property Key.
Implements IMessage.
|
protected |
|
protected |
Set the value of int property Key.
Implements IMessage.
|
protected |
| TBTMessage::SetStringProperty | ( | const string | Key, |
| const string | Value ) |
Set the value of string property Key.
Implements IMessage.
|
protected |
| RawByteString TBTMessage::Content |
The message content.
| string TBTMessage::CorrelationID |
| TDeliveryMode TBTMessage::DeliveryMode |
| IDestination TBTMessage::Destination |
| TDateTime TBTMessage::Expiration |
| string TBTMessage::JMSType |
| string TBTMessage::MessageID |
| Integer TBTMessage::Priority |
| Boolean TBTMessage::Redelivered |
| IDestination TBTMessage::ReplyTo |
| string TBTMessage::StompSubscriptionID |
required for ACK in STOMP 1.1
| TDateTime TBTMessage::Timestamp |
| string TBTMessage::TransactionID |