IMapMessage Interface Reference

Used to send a set of name-value pairs. More...

Inheritance diagram for IMapMessage:

Public Member Functions
PMStrings	GetMapNames ()
	Returns a list of all the names in the MapMessage object.
Boolean	ItemExists (const string Name)
	Indicates whether an item exists in this MapMessage object.
	SetBoolean (const string Name, const Boolean Value)
	Sets the Boolean value with the specified name.
Boolean	GetBoolean (const string Name)
	Returns the Boolean value with the specified name.
	SetInt (const string Name, const Integer Value)
	Sets the Integer value with the specified name.
Integer	GetInt (const string Name)
	Returns the Integer value with the specified name.
	SetString (const string Name, const string Value)
	Sets the string value with the specified name.
string	GetString (const string Name)
	Returns the string value with the specified name.
Public Member Functions inherited from IMessage
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.

Additional Inherited Members
Public Attributes inherited from IMessage
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

Used to send a set of name-value pairs.

The names are String objects, and the values are primitive data types. The names must have a value that is not an empty string. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined.

IMapMessage inherits from the IMessage interface and adds a message body that contains a Map.

Member Function Documentation

GetBoolean()

Boolean IMapMessage::GetBoolean

(

const string

Name

)

Returns the Boolean value with the specified name.

Implemented in TBTMapMessage.

GetInt()

Integer IMapMessage::GetInt

(

const string

Name

)

Returns the Integer value with the specified name.

Implemented in TBTMapMessage.

GetMapNames()

PMStrings IMapMessage::GetMapNames

(

)

Returns a list of all the names in the MapMessage object.

Implemented in TBTMapMessage.

GetString()

string IMapMessage::GetString

(

const string

Name

)

Returns the string value with the specified name.

Implemented in TBTMapMessage.

ItemExists()

Boolean IMapMessage::ItemExists

(

const string

Name

)

Indicates whether an item exists in this MapMessage object.

Implemented in TBTMapMessage.

SetBoolean()

IMapMessage::SetBoolean	(	const string	Name,
		const Boolean	Value )

Sets the Boolean value with the specified name.

Implemented in TBTMapMessage.

SetInt()

IMapMessage::SetInt	(	const string	Name,
		const Integer	Value )

Sets the Integer value with the specified name.

Implemented in TBTMapMessage.

SetString()

IMapMessage::SetString	(	const string	Name,
		const string	Value )

Sets the string value with the specified name.

Implemented in TBTMapMessage.