IMQProducer Interface Reference

Interface for producing messages. More...

Inheritance diagram for IMQProducer:

Public Member Functions
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

Member Function Documentation

ClearProperties()

IMQProducer::ClearProperties

(

)

Clears all properties set on this producer.

Implemented in TBTMQProducer.

GetBooleanProperty()

Boolean IMQProducer::GetBooleanProperty

(

const string

Key

)

Gets a boolean property value.

Parameters

Key	The property key

Returns

The boolean value

Implemented in TBTMQProducer.

GetCorrelationID()

string IMQProducer::GetCorrelationID

(

)

Gets the correlation ID for this producer.

Returns

The correlation ID

Implemented in TBTMQProducer.

GetDeliveryMode()

TJMSDeliveryMode IMQProducer::GetDeliveryMode

(

)

Gets the current delivery mode for this producer.

Returns

The delivery mode

Implemented in TBTMQProducer.

GetIntProperty()

Integer IMQProducer::GetIntProperty

(

const string

Key

)

Gets an integer property value.

Parameters

Key	The property key

Returns

The integer value

Implemented in TBTMQProducer.

GetPriority()

Integer IMQProducer::GetPriority

(

)

Gets the current priority for messages sent by this producer.

Returns

The priority level

Implemented in TBTMQProducer.

GetPropertyNames()

PMStrings IMQProducer::GetPropertyNames

(

)

Gets all property names set on this producer.

Returns

Array of property names

Implemented in TBTMQProducer.

GetReplyTo()

IDestination IMQProducer::GetReplyTo

(

)

Gets the current reply-to destination.

Returns

The reply-to destination

Implemented in TBTMQProducer.

GetStringProperty()

string IMQProducer::GetStringProperty

(

const string

Key

)

Gets a string property value.

Parameters

Key	The property key

Returns

The string value

Implemented in TBTMQProducer.

GetTimeToLive()

Cardinal IMQProducer::GetTimeToLive

(

)

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

Returns

The time to live in milliseconds

Implemented in TBTMQProducer.

GetTypeName()

string IMQProducer::GetTypeName

(

)

Gets the message type name.

Returns

The type name

Implemented in TBTMQProducer.

PropertyExists()

Boolean IMQProducer::PropertyExists

(

const string

Key

)

Checks if a property exists.

Parameters

Key	The property key to check

Returns

True if property exists, false otherwise

Implemented in TBTMQProducer.

Send() [1/4]

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

Implemented in TBTMQProducer.

Send() [2/4]

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

Deprecated

for removal in a future version

Implemented in TBTMQProducer.

Send() [3/4]

IMQProducer 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.

Implemented in TBTMQProducer.

Send() [4/4]

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

Deprecated

for removal in a future version

Implemented in TBTMQProducer.

SetCorrelationID()

IMQProducer::SetCorrelationID

(

const string

Value

)

Sets the correlation ID for messages sent by this producer.

Parameters

Value

The correlation ID to set

Implemented in TBTMQProducer.

SetDeliveryMode()

IMQProducer IMQProducer::SetDeliveryMode

(

const TJMSDeliveryMode

Value

)

Sets the delivery mode for messages sent by this producer.

Parameters

Value

The delivery mode to set

Returns

The producer instance for method chaining

Implemented in TBTMQProducer.

SetPriority()

IMQProducer IMQProducer::SetPriority

(

const Integer

Value

)

Sets the priority for messages sent by this producer.

Parameters

Value

The priority level

Returns

The producer instance for method chaining

Implemented in TBTMQProducer.

SetProperty() [1/3]

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

Sets a boolean property.

Parameters

Key	The property key
Value	The boolean value to set

Implemented in TBTMQProducer.

SetProperty() [2/3]

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

Sets an integer property.

Parameters

Key	The property key
Value	The integer value to set

Implemented in TBTMQProducer.

SetProperty() [3/3]

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

Sets a string property.

Parameters

Key	The property key
Value	The string value to set

Implemented in TBTMQProducer.

SetReplyTo()

IMQProducer::SetReplyTo

(

const IDestination

Value

)

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

Parameters

Value

The destination to reply to

Implemented in TBTMQProducer.

SetTimeToLive()

IMQProducer IMQProducer::SetTimeToLive

(

const Cardinal

Value

)

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

Implemented in TBTMQProducer.

SetTypeName()

IMQProducer::SetTypeName

(

const string

Value

)

Sets the message type name.

Parameters

Value

The type name to set

Implemented in TBTMQProducer.