The ITopicSubscriber type exposes the following members.

Methods

  NameDescription
Public methodClose
Closes the message consumer.

Since a provider may allocate some resources on behalf of a MessageConsumer outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

This call blocks until a receive or message listener in progress has completed. A blocked message consumer receive call returns null when this message consumer is closed.

(Inherited from IMessageConsumer.)
Public methodReceive()()()()
Receives the next message produced for this message consumer.

This call blocks indefinitely until a message is produced or until this message consumer is closed.

If this receive is done within a transaction, the consumer retains the message until the transaction commits.

(Inherited from IMessageConsumer.)
Public methodReceive(Int64)
Receives the next message that arrives within the specified timeout interval.

This call blocks until a message arrives, the timeout expires, or this message consumer is closed. A timeout of zero never expires, and the call blocks indefinitely.

(Inherited from IMessageConsumer.)
Public methodReceiveNoWait
Receives the next message if one is immediately available.

Return Value

the next message produced for this message consumer, or null if one is not available
(Inherited from IMessageConsumer.)

Properties

  NameDescription
Public propertyMessageListener

Sets the message consumer's MessageListener.

Setting the message listener to null is the equivalent of unsetting the message listener for the message consumer.

The effect of calling MessageConsumer.setMessageListener while messages are being consumed by an existing listener or the consumer is being used to consume messages synchronously is undefined.

(Inherited from IMessageConsumer.)
Public propertyMessageSelector
Gets this message consumer's message selector expression.
(Inherited from IMessageConsumer.)
Public propertyNoLocal
Gets the NoLocal attribute for this subscriber. The default value for this attribute is false.
Public propertyTopic
Gets the Topic associated with this subscriber.

See Also