Habari STOMP Client for ActiveMQ 9.4
Object Pascal STOMP client library for Apache ActiveMQ
Loading...
Searching...
No Matches
IMQConsumer Interface Reference

Interface for consuming messages. More...

Inheritance diagram for IMQConsumer:
TBTMQConsumer

Public Member Functions

 Close ()
 Closes the consumer.
string GetMessageSelector ()
 Gets this message consumer's message selector expression.
IMessage Receive ()
 Receives the next message produced for this message consumer.
IMessage Receive (const Integer Timeout)
 Receives the next message that arrives within the specified timeout interval.
IMessage ReceiveNoWait ()
 Receives the next message if one is immediately available.

Detailed Description

Interface for consuming messages.

Since
6.0

Member Function Documentation

◆ Close()

IMQConsumer::Close ( )

Closes the consumer.

Since a provider may allocate some resources on behalf of a MessageConsumer, clients should close them when they are not needed.

Exceptions
EMQException

Implemented in TBTMQConsumer.

◆ GetMessageSelector()

string IMQConsumer::GetMessageSelector ( )

Gets this message consumer's message selector expression.

Returns
the message selector expression
Note
MessageSelector is not supported by RabbitMQ

Implemented in TBTMQConsumer.

◆ Receive() [1/2]

IMessage IMQConsumer::Receive ( )

Receives the next message produced for this message consumer.

Implemented in TBTMQConsumer.

◆ Receive() [2/2]

IMessage IMQConsumer::Receive ( const Integer Timeout)

Receives the next message that arrives within the specified timeout interval.

Implemented in TBTMQConsumer.

◆ ReceiveNoWait()

IMessage IMQConsumer::ReceiveNoWait ( )

Receives the next message if one is immediately available.

Implemented in TBTMQConsumer.