TBTMQProducer Class Reference

Interface for producing messages. More...

Inheritance diagram for TBTMQProducer:

Public Member Functions
	TBTMQProducer (const ISession Session)
	Constructor.

Protected Member Functions
	InternalSend (const IMessage AMessage, const IDestination Destination, const ICompletionListener CompletionListener)
IMQProducer	SetDeliveryMode (const TJMSDeliveryMode Value)
	Sets the delivery mode for messages sent by this producer.
IMQProducer	SetPriority (const Integer Value)
	Sets the priority for messages sent by this producer.
IMQProducer	SetTimeToLive (const Cardinal Value)
	Sets the time-to-live for messages sent by this producer.
TJMSDeliveryMode	GetDeliveryMode ()
	Gets the current delivery mode for this producer.
Integer	GetPriority ()
	Gets the current priority for messages sent by this producer.
Cardinal	GetTimeToLive ()
	Gets the current time-to-live for messages sent by this producer.
	SetCorrelationID (const string Value)
	Sets the correlation ID for messages sent by this producer.
string	GetCorrelationID ()
	Gets the correlation ID for this producer.
string	GetTypeName ()
	Gets the message type name.
	SetTypeName (const string Value)
	Sets the message type name.
	SetReplyTo (const IDestination Value)
	Sets the reply-to destination for messages sent by this producer.
IDestination	GetReplyTo ()
	Gets the current reply-to destination.
	ClearProperties ()
	Clears all properties set on this producer.
PMStrings	GetPropertyNames ()
	Gets all property names set on this producer.
Boolean	PropertyExists (const string Key)
	Checks if a property exists.
Boolean	GetBooleanProperty (const string Key)
	Gets a boolean property value.
	SetProperty (const string Key, const Boolean Value)
	Sets a boolean property.
Integer	GetIntProperty (const string Key)
	Gets an integer property value.
	SetProperty (const string Key, const Integer Value)
	Sets an integer property.
string	GetStringProperty (const string Key)
	Gets a string property value.
	SetProperty (const string Key, const string Value)
	Sets a string property.
IMQProducer	Send (const IDestination Destination, const string Body)
	Send a TextMessage with the specified body to the specified destination, using any send options, message properties and message headers that have been defined on this Producer.
IMQProducer	Send (const IDestination Destination, const string Body, const ICompletionListener CompletionListener)
IMQProducer	Send (const IDestination Destination, const IMessage AMessage)
IMQProducer	Send (const IDestination Destination, const IMessage AMessage, const ICompletionListener CompletionListener)

Detailed Description

Interface for producing messages.

Since

6.0

Constructor & Destructor Documentation

TBTMQProducer()

TBTMQProducer::TBTMQProducer

(

const ISession

Session

)

Constructor.

Member Function Documentation

ClearProperties()

TBTMQProducer::ClearProperties ( )

protected

Clears all properties set on this producer.

Implements IMQProducer.

GetBooleanProperty()

Boolean TBTMQProducer::GetBooleanProperty ( const string Key )

protected

Gets a boolean property value.

Parameters

Key	The property key

Returns

The boolean value

Implements IMQProducer.

GetCorrelationID()

string TBTMQProducer::GetCorrelationID ( )

protected

Gets the correlation ID for this producer.

Returns

The correlation ID

Implements IMQProducer.

GetDeliveryMode()

TJMSDeliveryMode TBTMQProducer::GetDeliveryMode ( )

protected

Gets the current delivery mode for this producer.

Returns

The delivery mode

Implements IMQProducer.

GetIntProperty()

Integer TBTMQProducer::GetIntProperty ( const string Key )

protected

Gets an integer property value.

Parameters

Key	The property key

Returns

The integer value

Implements IMQProducer.

GetPriority()

Integer TBTMQProducer::GetPriority ( )

protected

Gets the current priority for messages sent by this producer.

Returns

The priority level

Implements IMQProducer.

GetPropertyNames()

PMStrings TBTMQProducer::GetPropertyNames ( )

protected

Gets all property names set on this producer.

Returns

Array of property names

Implements IMQProducer.

GetReplyTo()

IDestination TBTMQProducer::GetReplyTo ( )

protected

Gets the current reply-to destination.

Returns

The reply-to destination

Implements IMQProducer.

GetStringProperty()

string TBTMQProducer::GetStringProperty ( const string Key )

protected

Gets a string property value.

Parameters

Key	The property key

Returns

The string value

Implements IMQProducer.

GetTimeToLive()

Cardinal TBTMQProducer::GetTimeToLive ( )

protected

Gets the current time-to-live for messages sent by this producer.

Returns

The time to live in milliseconds

Implements IMQProducer.

GetTypeName()

string TBTMQProducer::GetTypeName ( )

protected

Gets the message type name.

Returns

The type name

Implements IMQProducer.

InternalSend()

TBTMQProducer::InternalSend ( const IMessage AMessage, const IDestination Destination, const ICompletionListener CompletionListener )

protected

PropertyExists()

Boolean TBTMQProducer::PropertyExists ( const string Key )

protected

Checks if a property exists.

Parameters

Key	The property key to check

Returns

True if property exists, false otherwise

Implements IMQProducer.

Send() [1/4]

IMQProducer TBTMQProducer::Send ( const IDestination Destination, const IMessage AMessage )

protected

Implements IMQProducer.

Send() [2/4]

IMQProducer TBTMQProducer::Send ( const IDestination Destination, const IMessage AMessage, const ICompletionListener CompletionListener )

protected

Deprecated

for removal in a future version

Implements IMQProducer.

Send() [3/4]

IMQProducer TBTMQProducer::Send ( const IDestination Destination, const string Body )

protected

Send a TextMessage with the specified body to the specified destination, using any send options, message properties and message headers that have been defined on this Producer.

Implements IMQProducer.

Send() [4/4]

IMQProducer TBTMQProducer::Send ( const IDestination Destination, const string Body, const ICompletionListener CompletionListener )

protected

Deprecated

for removal in a future version

Implements IMQProducer.

SetCorrelationID()

TBTMQProducer::SetCorrelationID ( const string Value )

protected

Sets the correlation ID for messages sent by this producer.

Parameters

Value

The correlation ID to set

Implements IMQProducer.

SetDeliveryMode()

IMQProducer TBTMQProducer::SetDeliveryMode ( const TJMSDeliveryMode Value )

protected

Sets the delivery mode for messages sent by this producer.

Parameters

Value

The delivery mode to set

Returns

The producer instance for method chaining

Implements IMQProducer.

SetPriority()

IMQProducer TBTMQProducer::SetPriority ( const Integer Value )

protected

Sets the priority for messages sent by this producer.

Parameters

Value

The priority level

Returns

The producer instance for method chaining

Implements IMQProducer.

SetProperty() [1/3]

TBTMQProducer::SetProperty ( const string Key, const Boolean Value )

protected

Sets a boolean property.

Parameters

Key	The property key
Value	The boolean value to set

Implements IMQProducer.

SetProperty() [2/3]

TBTMQProducer::SetProperty ( const string Key, const Integer Value )

protected

Sets an integer property.

Parameters

Key	The property key
Value	The integer value to set

Implements IMQProducer.

SetProperty() [3/3]

TBTMQProducer::SetProperty ( const string Key, const string Value )

protected

Sets a string property.

Parameters

Key	The property key
Value	The string value to set

Implements IMQProducer.

SetReplyTo()

TBTMQProducer::SetReplyTo ( const IDestination Value )

protected

Sets the reply-to destination for messages sent by this producer.

Parameters

Value

The destination to reply to

Implements IMQProducer.

SetTimeToLive()

IMQProducer TBTMQProducer::SetTimeToLive ( const Cardinal Value )

protected

Sets the time-to-live for messages sent by this producer.

Parameters

Value

The time to live in milliseconds

Returns

The producer instance for method chaining

Implements IMQProducer.

SetTypeName()

TBTMQProducer::SetTypeName ( const string Value )

protected

Sets the message type name.

Parameters

Value

The type name to set

Implements IMQProducer.