BTMQInterfaces.pas File Reference

Macros
#define	d

Enumerations
enum	TJMSDeliveryMode { dmNonPersistent , dmPersistent }
enum	TDestinationType { dtQueue , dtTopic , dtTemporaryQueue , dtTemporaryTopic }
	TDestinationType. More...

Functions
	SetDestinationType (TDestinationType Value)
string	GetMessageID ()
	SetDestination (const IDestination Value)
IDestination	GetDestination ()
	SetReplyTo (const IDestination Value)
IDestination	GetReplyTo ()
	SetPriority (const Integer Value)
Integer	GetPriority ()
	SetJMSDeliveryMode (const TJMSDeliveryMode Value)
TJMSDeliveryMode	GetJMSDeliveryMode ()
	SetJMSRedelivered (const Boolean Value)
Boolean	GetJMSRedelivered ()
	SetExpiration (const TDateTime Value)
TDateTime	GetExpiration ()
	SetCorrelationID (const string Value)
string	GetCorrelationID ()
string	GetTypeName ()
	SetTypeName (const string Value)
PMStrings	GetPropertyNames ()
Boolean	GetBooleanProperty (const string Key)
	SetBooleanProperty (const string Key, const Boolean Value)
Integer	GetIntProperty (const string Key)
	SetIntProperty (const string Key, const Integer Value)
string	GetStringProperty (const string Key)
	SetStringProperty (const string Key, const string Value)
	SetTimestamp (TDateTime Value)
TDateTime	GetTimestamp ()
	Acknowledge ()
	Nack ()
string	GetText ()
RawByteString	GetContent ()
TObject	GetObject ()
Boolean	ItemExists (const string Name)
	Indicates whether an item exists in this MapMessage object.
	SetBoolean (const string Name, const Boolean Value)
Boolean	GetBoolean (const string Name)
	SetInt (const string Name, const Integer Value)
Integer	GetInt (const string Name)
	SetString (const string Name, const string Value)
string	GetString (const string Name)
	SetTimeToLive (const Cardinal Value)
TJMSDeliveryMode	GetDeliveryMode ()
Cardinal	GetTimeToLive ()
	Close ()
	Send (const IMessage Message)
	Send (const IDestination Destination, const IMessage Message)
	Send (const IMessage Message, const TJMSDeliveryMode DeliveryMode, const Integer Priority, const Integer TimeToLive)
	Send (const IDestination Destination, const IMessage Message, const TJMSDeliveryMode DeliveryMode, const Integer Priority, const Integer TimeToLive)
IMessage	Receive ()
IMessage	Receive (const Integer Timeout)
IMessage	ReceiveNoWait ()
ITopic	GetTopic ()
	Commit ()
IBytesMessage	CreateBytesMessage ()
IMessageConsumer	CreateConsumer (const IDestination Destination)
IMessageConsumer	CreateConsumer (const IDestination Destination, const string MessageSelector)
IMessageConsumer	CreateConsumer (const IDestination Destination, const string MessageSelector, const Boolean NoLocal)
ITopicSubscriber	CreateDurableSubscriber (const ITopic Topic, const string Name)
ITopicSubscriber	CreateDurableSubscriber (const ITopic Topic, const string Name, const string MessageSelector, const Boolean NoLocal)
IMessage	CreateMessage ()
IMessageProducer	CreateProducer (const IDestination Destination)
IQueue	CreateQueue (const string QueueName)
ITemporaryQueue	CreateTemporaryQueue ()
ITemporaryTopic	CreateTemporaryTopic ()
IQueueBrowser	CreateBrowser (const string QueueName)
IObjectMessage	CreateObjectMessage ()
IObjectMessage	CreateObjectMessage (const TObject AObject)
ITextMessage	CreateTextMessage ()
IMapMessage	CreateMapMessage ()
ITextMessage	CreateTextMessage (const string Text)
ITopic	CreateTopic (const string TopicName)
TAcknowledgementMode	GetAcknowledgeMode ()
Boolean	GetTransacted ()
	Rollback ()
	Unsubscribe (const string Destination, const string Name)
	SetClientID (const string Value)
	Start ()
	Stop ()
ISession	CreateSession (const Boolean Transacted, const TAcknowledgementMode AcknowledgementMode)
ISession	CreateSession (const TAcknowledgementMode AcknowledgementMode)
string	GetMessageSelector ()
	OnException (const IMessage Message, const Exception Exception)
	ClearProperties ()
Boolean	PropertyExists (const string Key)
	SetProperty (const string Key, const Boolean Value)
	SetProperty (const string Key, const Integer Value)
	SetProperty (const string Key, const string Value)
IMQProducer	Send (const IDestination Destination, const string Body)
IMQProducer	Send (const IDestination Destination, const string Body, const ICompletionListener CompletionListener)
IMQProducer	Send (const IDestination Destination, const IMessage AMessage, const ICompletionListener CompletionListener)
ITopicSubscriber	CreateDurableSubscriber (const ITopic Topic, const string Name, const string MessageSelector)
IMQProducer	CreateProducer ()
string	GetClientID ()
IConnection	CreateConnection (const string Username, const string Password)
	Creates a connection with the specified user identity.
IMQContext	CreateContext ()
	Creates a context.
IMQContext	CreateContext (const TAcknowledgementMode AcknowledgeMode)
IMQContext	CreateContext (const string Username, const string Password)
IMQContext	CreateContext (const string Username, const string Password, const TAcknowledgementMode AcknowledgeMode)

Variables
const	DEFAULT_DELIVERY_MODE = dmNonPersistent
const	DEFAULT_TIME_TO_LIVE = 0
TDestinationType	DestinationType
	end
	IQueue
string	QueueName
	The name of this queue.
	ITemporaryQueue
	ITopic
string	TopicName
	The name of this topic.
	ITemporaryTopic
	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.
	ITextMessage
string	Text
	IBytesMessage
RawByteString	Content
	IObjectMessage
	IMapMessage
	IMessageProducer
TJMSDeliveryMode	DeliveryMode
Integer	Priority
Cardinal	TimeToLive
	IMessageConsumer
	IQueueEnumeration
	IQueueBrowser
	ITopicSubscriber
	TAcknowledgementMode
	Acknowledgment Mode.
	ISession
TAcknowledgementMode	AcknowledgeMode
Boolean	Transacted
	IConnection
string	ClientID
	IMQConsumer
	ICompletionListener
	IMQProducer
	IMQContext
	IConnectionFactory

Macro Definition Documentation

d

#define d

Enumeration Type Documentation

TDestinationType

enum TDestinationType

TDestinationType.

Enumerator
dtQueue
dtTopic
dtTemporaryQueue
dtTemporaryTopic

TJMSDeliveryMode

enum TJMSDeliveryMode

Enumerator
dmNonPersistent
dmPersistent

Function Documentation

Acknowledge()

Acknowledge

(

)

ClearProperties()

ClearProperties

(

)

Close()

Close

(

)

Commit()

Commit

(

)

CreateBrowser()

IQueueBrowser CreateBrowser

(

const string

QueueName

)

CreateBytesMessage()

IBytesMessage CreateBytesMessage

(

)

CreateConnection()

IConnection CreateConnection	(	const string	Username,
		const string	Password )

Creates a connection with the specified user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.Start method is explicitly called.

CreateConsumer() [1/3]

IMQConsumer CreateConsumer

(

const IDestination

Destination

)

CreateConsumer() [2/3]

IMQConsumer CreateConsumer	(	const IDestination	Destination,
		const string	MessageSelector )

CreateConsumer() [3/3]

IMessageConsumer CreateConsumer	(	const IDestination	Destination,
		const string	MessageSelector,
		const Boolean	NoLocal )

CreateContext() [1/4]

IMQContext CreateContext

(

)

Creates a context.

Since

6.0

CreateContext() [2/4]

IMQContext CreateContext	(	const string	Username,
		const string	Password )

CreateContext() [3/4]

IMQContext CreateContext	(	const string	Username,
		const string	Password,
		const TAcknowledgementMode	AcknowledgeMode )

CreateContext() [4/4]

IMQContext CreateContext

(

const TAcknowledgementMode

AcknowledgeMode

)

CreateDurableSubscriber() [1/3]

ITopicSubscriber CreateDurableSubscriber	(	const ITopic	Topic,
		const string	Name )

CreateDurableSubscriber() [2/3]

ITopicSubscriber CreateDurableSubscriber	(	const ITopic	Topic,
		const string	Name,
		const string	MessageSelector )

CreateDurableSubscriber() [3/3]

ITopicSubscriber CreateDurableSubscriber	(	const ITopic	Topic,
		const string	Name,
		const string	MessageSelector,
		const Boolean	NoLocal )

CreateMapMessage()

IMapMessage CreateMapMessage

(

)

CreateMessage()

IMessage CreateMessage

(

)

CreateObjectMessage() [1/2]

IObjectMessage CreateObjectMessage

(

)

CreateObjectMessage() [2/2]

IObjectMessage CreateObjectMessage

(

const TObject

AObject

)

CreateProducer() [1/2]

IMQProducer CreateProducer

(

)

CreateProducer() [2/2]

IMessageProducer CreateProducer

(

const IDestination

Destination

)

CreateQueue()

IQueue CreateQueue

(

const string

QueueName

)

CreateSession() [1/2]

ISession CreateSession	(	const Boolean	Transacted,
		const TAcknowledgementMode	AcknowledgementMode )

CreateSession() [2/2]

ISession CreateSession

(

const TAcknowledgementMode

AcknowledgementMode

)

CreateTemporaryQueue()

ITemporaryQueue CreateTemporaryQueue

(

)

CreateTemporaryTopic()

ITemporaryTopic CreateTemporaryTopic

(

)

CreateTextMessage() [1/2]

ITextMessage CreateTextMessage

(

)

CreateTextMessage() [2/2]

ITextMessage CreateTextMessage

(

const string

Text

)

CreateTopic()

ITopic CreateTopic

(

const string

TopicName

)

GetAcknowledgeMode()

TAcknowledgementMode GetAcknowledgeMode

(

)

GetBoolean()

Boolean GetBoolean

(

const string

Name

)

GetBooleanProperty()

Boolean GetBooleanProperty

(

const string

Key

)

GetClientID()

string GetClientID

(

)

GetContent()

RawByteString GetContent

(

)

GetCorrelationID()

string GetCorrelationID

(

)

GetDeliveryMode()

TJMSDeliveryMode GetDeliveryMode

(

)

GetDestination()

IDestination GetDestination

(

)

GetExpiration()

TDateTime GetExpiration

(

)

GetInt()

Integer GetInt

(

const string

Name

)

GetIntProperty()

Integer GetIntProperty

(

const string

Key

)

GetJMSDeliveryMode()

TJMSDeliveryMode GetJMSDeliveryMode

(

)

GetJMSRedelivered()

Boolean GetJMSRedelivered

(

)

GetMessageID()

string GetMessageID

(

)

GetMessageSelector()

string GetMessageSelector

(

)

GetObject()

TObject GetObject

(

)

GetPriority()

Integer GetPriority

(

)

GetPropertyNames()

PMStrings GetPropertyNames

(

)

GetReplyTo()

IDestination GetReplyTo

(

)

GetString()

string GetString

(

const string

Name

)

GetStringProperty()

string GetStringProperty

(

const string

Key

)

GetText()

string GetText

(

)

GetTimestamp()

TDateTime GetTimestamp

(

)

GetTimeToLive()

Cardinal GetTimeToLive

(

)

GetTopic()

ITopic GetTopic

(

)

GetTransacted()

Boolean GetTransacted

(

)

GetTypeName()

string GetTypeName

(

)

ItemExists()

Boolean ItemExists

(

const string

Name

)

Indicates whether an item exists in this MapMessage object.

Nack()

Nack

(

)

OnException()

OnException	(	const IMessage	Message,
		const Exception	Exception )

PropertyExists()

Boolean PropertyExists

(

const string

Key

)

Receive() [1/2]

IMessage Receive

(

)

Receive() [2/2]

IMessage Receive

(

const Integer

Timeout

)

ReceiveNoWait()

IMessage ReceiveNoWait

(

)

Rollback()

Rollback

(

)

Send() [1/7]

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

Send() [2/7]

IMQProducer Send	(	const IDestination	Destination,
		const IMessage	Message )

Send() [3/7]

Send	(	const IDestination	Destination,
		const IMessage	Message,
		const TJMSDeliveryMode	DeliveryMode,
		const Integer	Priority,
		const Integer	TimeToLive )

Send() [4/7]

IMQProducer Send	(	const IDestination	Destination,
		const string	Body )

Send() [5/7]

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

Send() [6/7]

Send

(

const IMessage

Message

)

Send() [7/7]

Send	(	const IMessage	Message,
		const TJMSDeliveryMode	DeliveryMode,
		const Integer	Priority,
		const Integer	TimeToLive )

SetBoolean()

SetBoolean	(	const string	Name,
		const Boolean	Value )

SetBooleanProperty()

SetBooleanProperty	(	const string	Key,
		const Boolean	Value )

SetClientID()

SetClientID

(

const string

Value

)

SetCorrelationID()

SetCorrelationID

(

const string

Value

)

SetDestination()

SetDestination

(

const IDestination

Value

)

SetDestinationType()

SetDestinationType

(

TDestinationType

Value

)

SetExpiration()

SetExpiration

(

const TDateTime

Value

)

SetInt()

SetInt	(	const string	Name,
		const Integer	Value )

SetIntProperty()

SetIntProperty	(	const string	Key,
		const Integer	Value )

SetJMSDeliveryMode()

SetJMSDeliveryMode

(

const TJMSDeliveryMode

Value

)

SetJMSRedelivered()

SetJMSRedelivered

(

const Boolean

Value

)

SetPriority()

IMQProducer SetPriority

(

const Integer

Value

)

SetProperty() [1/3]

SetProperty	(	const string	Key,
		const Boolean	Value )

SetProperty() [2/3]

SetProperty	(	const string	Key,
		const Integer	Value )

SetProperty() [3/3]

SetProperty	(	const string	Key,
		const string	Value )

SetReplyTo()

SetReplyTo

(

const IDestination

Value

)

SetString()

SetString	(	const string	Name,
		const string	Value )

SetStringProperty()

SetStringProperty	(	const string	Key,
		const string	Value )

SetTimestamp()

SetTimestamp

(

TDateTime

Value

)

SetTimeToLive()

IMQProducer SetTimeToLive

(

const Cardinal

Value

)

SetTypeName()

SetTypeName

(

const string

Value

)

Start()

Start

(

)

Stop()

Stop

(

)

Unsubscribe()

Unsubscribe	(	const string	Destination,
		const string	Name )

Variable Documentation

AcknowledgeMode

TAcknowledgementMode AcknowledgeMode

See also

GetAcknowledgeMode For reading

ClientID

string ClientID

See also

GetClientId For reading

SetClientId For writing

Content

RawByteString Content

See also

GetContent For reading

SetContent For writing

DEFAULT_DELIVERY_MODE

const DEFAULT_DELIVERY_MODE = dmNonPersistent

DEFAULT_TIME_TO_LIVE

const DEFAULT_TIME_TO_LIVE = 0

DeliveryMode

TJMSDeliveryMode DeliveryMode

See also

GetDeliveryMode For reading

SetDeliveryMode For writing

DestinationType

TDestinationType DestinationType

See also

GetDestinationType For reading

SetDestinationType For writing

end

end

IBytesMessage

IBytesMessage

Initial value:

= (IMessage)
    [' ']
       
SetContent (const RawByteString Value 
)

ICompletionListener

ICompletionListener

Initial value:

= 
    [' ']
 
    
       
OnMessage (const IMessage Message 
)

IConnection

IConnection

Initial value:

= 
    [' ']
 
      
string GetClientID ()

IConnectionFactory

IConnectionFactory

Initial value:

= 
    [' ']
     
      
IConnection CreateConnection ()

IMapMessage

IMapMessage

Initial value:

= (IMessage)
    [' ']
     
      
PMStrings GetMapNames ()

IMessage

IMessage

Initial value:

= 
    [' ']
    
       
SetMessageID (const string Value 
)

IMessageConsumer

IMessageConsumer

Initial value:

= 
    [' ']
 
 
 
 
 
 
 
 
 
 
 
 
      
string GetMessageSelector ()

IMessageProducer

IMessageProducer

Initial value:

= 
    [' ']
       
SetDeliveryMode (const TJMSDeliveryMode Value 
)

IMQConsumer

IMQConsumer

Initial value:

= 
    [' ']
 
     
Close ()

IMQContext

IMQContext

Initial value:

= 
    [' ']
 
    
     
Close ()

IMQProducer

IMQProducer

Initial value:

= 
    [' ']
 
        
IMQProducer SetDeliveryMode (const TJMSDeliveryMode Value 
)

IObjectMessage

IObjectMessage

Initial value:

= (IMessage)
    [' ']
       
SetObject (const TObject AObject 
)

IQueue

IQueue

Initial value:

= (IDestination)
    [' ']
      
string GetQueueName ()

IQueueBrowser

IQueueBrowser

Initial value:

= 
    [' ']
      
IQueueEnumeration GetEnumeration ()

IQueueEnumeration

IQueueEnumeration

Initial value:

= 
    [' ']
      
IMessage Next ()

ISession

ISession

Initial value:

= 
    [' ']
    
     
Close ()

ITemporaryQueue

ITemporaryQueue

Initial value:

= (IQueue)
    [' ']
     
     
Delete ()

ITemporaryTopic

ITemporaryTopic

Initial value:

= (ITopic)
    [' ']
     
     
Delete ()

ITextMessage

ITextMessage

Initial value:

= (IMessage)
    [' ']
       
SetText (const string Value 
)

ITopic

ITopic

Initial value:

= (IDestination)
    [' ']
      
string GetTopicName ()

ITopicSubscriber

ITopicSubscriber

Initial value:

= (IMessageConsumer)
    [' ']
      
Boolean GetNoLocal ()

JMSCorrelationID

string JMSCorrelationID

The correlation ID for the message.

A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

See also

GetCorrelationID For reading

SetCorrelationID For writing

JMSDeliveryMode

TJMSDeliveryMode JMSDeliveryMode

Whether or not the message is persistent.

Message providers set this field when a message is sent.

See also

GetJMSDeliveryMode For reading

SetJMSDeliveryMode For writing

JMSDestination

IDestination JMSDestination

Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

See also

GetDestination For reading

SetDestination For writing

JMSExpiration

TDateTime JMSExpiration

The message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

See also

GetExpiration For reading

SetExpiration For writing

JMSMessageID

string JMSMessageID

The message ID which is set by the provider.

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

Note

this header field is not supported by the STOMP specifications and STOMP-JMS bindings of supported brokers.

See also

GetMessageID For reading

SetMessageID For writing

JMSPriority

Integer JMSPriority

The message priority level.

The API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest.

The API does not require that a provider strictly implements priority ordering of messages.

Providers set this field when a message is sent. To send a message with a priority, use the IMessageProducer's Priority property.

See also

GetPriority For reading

SetPriority For writing

JMSRedelivered

Boolean JMSRedelivered

Redelivered - Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.

If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

See also

GetJMSRedelivered For reading

SetJMSRedelivered For writing

JMSReplyTo

IDestination JMSReplyTo

The IDestination object to which a reply to this message should be sent.

The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a IQueue object or a ITopic object.

See also

GetReplyTo For reading

SetReplyTo For writing

JMSTimestamp

TDateTime JMSTimestamp

The timestamp the broker added to the message.

The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return.

Note

this header field is not supported by the STOMP specifications and STOMP-JMS bindings of supported brokers.

See also

GetTimestamp For reading

SetTimestamp For writing

JMSType

string JMSType

The type name of this message.

Some providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

See also

GetTypeName For reading

SetTypeName For writing

Priority

Integer Priority

See also

GetPriority For reading

SetPriority For writing

QueueName

string QueueName

The name of this queue.

See also

GetQueueName For reading

TAcknowledgementMode

TAcknowledgementMode

Initial value:

= (
    amClientAcknowledge,
    amTransactional,
    amAutoAcknowledge,
    amClientIndividual)

Acknowledgment Mode.

amTransactional A session created with acknowledgment mode amTransactional will automatically start a transaction.

amClientAcknowledge This acknowledgment mode activates the STOMP ack mode "client".

With this acknowledgment mode, the client acknowledges a consumed message by calling the message's acknowledge method.

amAutoAcknowledge This acknowledgment mode activates the STOMP ack mode "auto".

Note

When the ack mode is auto, then the client does not need to send the server ACK frames for the messages it receives. The server will assume the client has received the message as soon as it sends it to the client. This acknowledgment mode can cause messages being transmitted to the client to get dropped.

amClientIndividual This acknowledgment mode activates the STOMP ack mode "client-individual".

Note

When the ack mode is client-individual, the acknowledgment operates just like the client acknowledgment mode except that the ACK or NACK frames sent by the client are not cumulative. This means that an ACK or NACK frame for a subsequent message MUST NOT cause a previous message to get acknowledged.

See also

http://stomp.github.io/stomp-specification-1.2.html#SUBSCRIBE_ack_Header

Text

string Text

See also

GetText For reading

SetText For writing

TimeToLive

Cardinal TimeToLive

See also

GetTimeToLive For reading

SetTimeToLive For writing

TopicName

string TopicName

The name of this topic.

See also

GetTopicName For reading

Transacted

Boolean Transacted

See also

GetTransacted For reading