Inherits from KMConnection : KCObject : NSObject
Declared in KMTopicConnection.h

Overview

A TopicConnection object is an active connection to a publish/subscribe JMS provider. A client uses a TopicConnection object to create one or more TopicSession objects for producing and consuming messages.

KMTopicConnection is a JMS 1.0 API. KMConnection should be used instead.

A TopicConnection can be used to create a TopicSession, from which specialized topic-related objects can be created. A more general, and recommended approach is to use the Connection object.

Tasks

Instance Methods

createConnectionConsumer:messageSelector:sessionPool:maxMessages:

Creates a connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.

- (KMConnectionConsumer *)createConnectionConsumer:(KMTopic *)topic messageSelector:(NSString *)messageSelector sessionPool:(KMServerSessionPool *)sessionPool maxMessages:(int)maxMessages

Parameters

topic

the topic to access

messageSelector

only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

sessionPool

the server session pool to associate with this connection consumer

maxMessages

the maximum number of messages that can be assigned to a server session at one time

Return Value

the connection consumer

Exceptions

KMJMSException

if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.

KMInvalidDestinationException

if an invalid topic is specified.

KMInvalidSelectorException

if the message selector is invalid.

Declared In

KMTopicConnection.h

createDurableConnectionConsumer:subscriptionName:messageSelector:sessionPool:maxMessages:

Create a durable connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.

- (KMConnectionConsumer *)createDurableConnectionConsumer:(KMTopic *)topic subscriptionName:(NSString *)subscriptionName messageSelector:(NSString *)messageSelector sessionPool:(KMServerSessionPool *)sessionPool maxMessages:(int)maxMessages

Parameters

topic

the topic to access

subscriptionName

durable subscription name

messageSelector

only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

sessionPool

the server session pool to associate with this durable connection consumer

maxMessages

the maximum number of messages that can be assigned to a server session at one time

Return Value

the durable connection consumer

Exceptions

KMJMSException

if the TopicConnection object fails to create a connection consumer due to some internal error or invalid arguments for sessionPool and messageSelector.

KMInvalidDestinationException

if an invalid topic is specified.

KMInvalidSelectorException

if the message selector is invalid.

Declared In

KMTopicConnection.h

createTopicSession:transacted:

Creates a TopicSession object.

- (KMTopicSession *)createTopicSession:(int)acknowledgeMode transacted:(BOOL)transacted

Parameters

acknowledgeMode

indicates whether the consumer or the client will acknowledge any messages it receives; ignored if the session is transacted. Legal values are KMSessionAutoAcknowledge, KMSessionClientAcknowledge, and KMSessionDupsOKAcknowledge.

transacted

indicates whether the session is transacted

Return Value

a newly created topic session

Exceptions

KMJMSException

if the TopicConnection object fails to create a session due to some internal error or lack of support for the specific transaction and acknowledgement mode.

See Also

Declared In

KMTopicConnection.h