TBTMessage Class Reference

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

Inheritance diagram for TBTMessage:

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	GetMsgID ()
RawByteString	GetContent ()
	SetContent (const RawByteString Value)
	Acknowledge ()
	Acknowledges all consumed messages of the session of this consumed message.
	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.

Detailed Description

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

Constructor & Destructor Documentation

TBTMessage() [1/3]

TBTMessage::TBTMessage

(

const TBTStompClient

ATransport

)

Constructor.

TBTMessage() [2/3]

TBTMessage::TBTMessage	(	const TBTStompClient	ATransport,
		const string	ASubscriptionID )

Constructor.

TBTMessage() [3/3]

TBTMessage::TBTMessage	(	const TBTStompClient	ATransport,
		const RawByteString	AContent,
		const string	ASubscriptionID )

Constructor.

~TBTMessage()

TBTMessage::~TBTMessage

(

)

Member Function Documentation

Acknowledge()

TBTMessage::Acknowledge ( )

protected

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.

Implements IMessage.

GetBooleanProperty()

Boolean TBTMessage::GetBooleanProperty ( const string Key )

protected

Get the value of boolean property Key.

Implements IMessage.

GetContent()

RawByteString TBTMessage::GetContent ( )

protected

GetIntProperty()

Integer TBTMessage::GetIntProperty ( const string Key )

protected

Get the value of int property Key.

Implements IMessage.

GetMsgID()

string TBTMessage::GetMsgID ( )

protected

GetPropertyNames()

PMStrings TBTMessage::GetPropertyNames

(

)

Returns a list of all the property names.

Implements IMessage.

GetStringProperty()

string TBTMessage::GetStringProperty

(

const string

Key

)

Get the value of string property Key.

Implements IMessage.

GetTransactionID()

string TBTMessage::GetTransactionID ( )

protected

Nack()

TBTMessage::Nack ( )

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.

SetBooleanProperty()

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

protected

Set the value of boolean property Key.

Implements IMessage.

SetContent()

TBTMessage::SetContent ( const RawByteString Value )

protected

SetIntProperty()

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

protected

Set the value of int property Key.

Implements IMessage.

SetNackHeaders()

TBTMessage::SetNackHeaders ( const TStrings Value )

protected

SetStringProperty()

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

Set the value of string property Key.

Implements IMessage.

SetTransactionID()

TBTMessage::SetTransactionID ( const string Value )

protected

Member Data Documentation

Content

RawByteString TBTMessage::Content

The message content.

See also

FContent For reading

CorrelationID

string TBTMessage::CorrelationID

See also

GetCorrelationID For reading

SetCorrelationID For writing

DeliveryMode

TDeliveryMode TBTMessage::DeliveryMode

See also

GetDeliveryMode For reading

SetDeliveryMode For writing

Destination

IDestination TBTMessage::Destination

See also

GetDestination For reading

SetDestination For writing

Expiration

TDateTime TBTMessage::Expiration

See also

GetExpiration For reading

SetExpiration For writing

JMSType

string TBTMessage::JMSType

See also

GetTypeName For reading

SetTypeName For writing

MessageID

string TBTMessage::MessageID

See also

GetMessageID For reading

SetMessageID For writing

Priority

Integer TBTMessage::Priority

See also

GetPriority For reading

SetPriority For writing

Redelivered

Boolean TBTMessage::Redelivered

See also

GetRedelivered For reading

SetRedelivered For writing

ReplyTo

IDestination TBTMessage::ReplyTo

See also

GetReplyTo For reading

SetReplyTo For writing

StompSubscriptionID

string TBTMessage::StompSubscriptionID

required for ACK in STOMP 1.1

See also

FSubscriptionID For reading

Timestamp

TDateTime TBTMessage::Timestamp

See also

GetTimestamp For reading

SetTimestamp For writing

TransactionID

string TBTMessage::TransactionID

See also

GetTransactionID For reading

SetTransactionID For writing