IMQContext Interface Reference

This interface represents a messaging context. More...

Inheritance diagram for IMQContext:

Public Member Functions
	Close ()
	Closes the context.
	Commit ()
	Commits the context.
IQueueBrowser	CreateBrowser (const string QueueName)
	Creates an IQueueBrowser object to peek at the messages on the specified queue.
IBytesMessage	CreateBytesMessage ()
	Creates a new binary message.
IMQConsumer	CreateConsumer (const IDestination Destination)
	Creates an IMQConsumer for the specified destination.
IMQConsumer	CreateConsumer (const IDestination Destination, const string MessageSelector)
	Creates an IMQConsumer for the specified destination, using a message selector.
ITopicSubscriber	CreateDurableSubscriber (const ITopic Topic, const string Name)
	Creates a durable subscriber to the specified topic.
ITopicSubscriber	CreateDurableSubscriber (const ITopic Topic, const string Name, const string MessageSelector)
	Creates a durable subscriber to the specified topic, using a message selector.
IMapMessage	CreateMapMessage ()
	Creates a new map message.
IObjectMessage	CreateObjectMessage ()
	Creates a new object message.
IObjectMessage	CreateObjectMessage (const TObject AObject)
	Creates a new object message with the given object.
IMQProducer	CreateProducer ()
	Creates a Producer object which can be used to configure and send messages.
IQueue	CreateQueue (const string QueueName)
	Creates a Queue object which encapsulates a specified provider-specific queue name.
ITemporaryQueue	CreateTemporaryQueue ()
	Creates an ITemporaryQueue object.
ITemporaryTopic	CreateTemporaryTopic ()
	Creates an ITemporaryTopic object.
ITextMessage	CreateTextMessage ()
	Creates a new text message with an empty body.
ITextMessage	CreateTextMessage (const string Text)
	Creates a new text message with the given body.
ITopic	CreateTopic (const string TopicName)
	Creates an ITopic object which encapsulates a specified provider-specific topic name.
TAcknowledgementMode	GetAcknowledgeMode ()
	Returns the acknowledgement mode of the context.
string	GetClientID ()
	Returns the client id.
Boolean	GetTransacted ()
	Indicates whether the session is in transacted mode.
	Rollback ()
	Rolls back the context.
	Start ()
	Starts the context.
	Stop ()
	Stops the context.
	Unsubscribe (const string Destination, const string Name)
	Unsubscribes a durable subscription that has been created by a client.

Detailed Description

This interface represents a messaging context.

Member Function Documentation

Close()

IMQContext::Close

(

)

Closes the context.

Implemented in TBTMQContext.

Commit()

IMQContext::Commit

(

)

Commits the context.

Implemented in TBTMQContext.

CreateBrowser()

IQueueBrowser IMQContext::CreateBrowser

(

const string

QueueName

)

Creates an IQueueBrowser object to peek at the messages on the specified queue.

Implemented in TBTMQContext.

CreateBytesMessage()

IBytesMessage IMQContext::CreateBytesMessage

(

)

Creates a new binary message.

Implemented in TBTMQContext.

CreateConsumer() [1/2]

IMQConsumer IMQContext::CreateConsumer

(

const IDestination

Destination

)

Creates an IMQConsumer for the specified destination.

Parameters

Destination

the IDestination to access

Returns

the consumer

Implemented in TBTMQContext.

CreateConsumer() [2/2]

IMQConsumer IMQContext::CreateConsumer	(	const IDestination	Destination,
		const string	MessageSelector )

Creates an IMQConsumer for the specified destination, using a message selector.

Parameters

Destination	the IDestination to access
MessageSelector	only messages with properties matching the message selector expression are delivered. An empty string indicates that there is no message selector for the message consumer.

Returns

the consumer

Note

MessageSelector is not supported by RabbitMQ

Implemented in TBTMQContext.

CreateDurableSubscriber() [1/2]

ITopicSubscriber IMQContext::CreateDurableSubscriber	(	const ITopic	Topic,
		const string	Name )

Creates a durable subscriber to the specified topic.

Parameters

Topic	the ITopic to access
Name	the name used to identify this subscription

Returns

the durable subscriber

Implemented in TBTMQContext.

CreateDurableSubscriber() [2/2]

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

Creates a durable subscriber to the specified topic, using a message selector.

Parameters

Topic	the ITopic to access
Name	the name used to identify this subscription
MessageSelector	only messages with properties matching the message selector expression are delivered. An empty string indicates that there is no message selector for the message consumer.

Returns

the durable subscriber

Note

MessageSelector is not supported by RabbitMQ

Implemented in TBTMQContext.

CreateMapMessage()

IMapMessage IMQContext::CreateMapMessage

(

)

Creates a new map message.

Implemented in TBTMQContext.

CreateObjectMessage() [1/2]

IObjectMessage IMQContext::CreateObjectMessage

(

)

Creates a new object message.

Implemented in TBTMQContext.

CreateObjectMessage() [2/2]

IObjectMessage IMQContext::CreateObjectMessage

(

const TObject

AObject

)

Creates a new object message with the given object.

Implemented in TBTMQContext.

CreateProducer()

IMQProducer IMQContext::CreateProducer

(

)

Creates a Producer object which can be used to configure and send messages.

Implemented in TBTMQContext.

CreateQueue()

IQueue IMQContext::CreateQueue

(

const string

QueueName

)

Creates a Queue object which encapsulates a specified provider-specific queue name.

Implemented in TBTMQContext.

CreateTemporaryQueue()

ITemporaryQueue IMQContext::CreateTemporaryQueue

(

)

Creates an ITemporaryQueue object.

Its lifetime will be that of the IConnection unless it is deleted earlier.

Implemented in TBTMQContext.

CreateTemporaryTopic()

ITemporaryTopic IMQContext::CreateTemporaryTopic

(

)

Creates an ITemporaryTopic object.

Its lifetime will be that of the IConnection unless it is deleted earlier.

Implemented in TBTMQContext.

CreateTextMessage() [1/2]

ITextMessage IMQContext::CreateTextMessage

(

)

Creates a new text message with an empty body.

Implemented in TBTMQContext.

CreateTextMessage() [2/2]

ITextMessage IMQContext::CreateTextMessage

(

const string

Text

)

Creates a new text message with the given body.

Implemented in TBTMQContext.

CreateTopic()

ITopic IMQContext::CreateTopic

(

const string

TopicName

)

Creates an ITopic object which encapsulates a specified provider-specific topic name.

Implemented in TBTMQContext.

GetAcknowledgeMode()

TAcknowledgementMode IMQContext::GetAcknowledgeMode

(

)

Returns the acknowledgement mode of the context.

Implemented in TBTMQContext.

GetClientID()

string IMQContext::GetClientID

(

)

Returns the client id.

Implemented in TBTMQContext.

GetTransacted()

Boolean IMQContext::GetTransacted

(

)

Indicates whether the session is in transacted mode.

Implemented in TBTMQContext.

Rollback()

IMQContext::Rollback

(

)

Rolls back the context.

Implemented in TBTMQContext.

Start()

IMQContext::Start

(

)

Starts the context.

Implemented in TBTMQContext.

Stop()

IMQContext::Stop

(

)

Stops the context.

Implemented in TBTMQContext.

Unsubscribe()

IMQContext::Unsubscribe	(	const string	Destination,
		const string	Name )

Unsubscribes a durable subscription that has been created by a client.

Implemented in TBTMQContext.