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

Interface for consuming messages. More...

Inheritance diagram for TBTMQConsumer:
IMQConsumer

Public Member Functions

 TBTMQConsumer (const ISession Session, const IDestination Destination)
 Constructor.
 TBTMQConsumer (const ISession Session, const IDestination Destination, const string MessageSelector)
 Constructor.

Protected 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

Constructor & Destructor Documentation

◆ TBTMQConsumer() [1/2]

TBTMQConsumer::TBTMQConsumer ( const ISession Session,
const IDestination Destination )

Constructor.

◆ TBTMQConsumer() [2/2]

TBTMQConsumer::TBTMQConsumer ( const ISession Session,
const IDestination Destination,
const string MessageSelector )

Constructor.

Member Function Documentation

◆ Close()

TBTMQConsumer::Close ( )
protected

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

Implements IMQConsumer.

◆ GetMessageSelector()

string TBTMQConsumer::GetMessageSelector ( )
protected

Gets this message consumer's message selector expression.

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

Implements IMQConsumer.

◆ Receive() [1/2]

IMessage TBTMQConsumer::Receive ( )
protected

Receives the next message produced for this message consumer.

Implements IMQConsumer.

◆ Receive() [2/2]

IMessage TBTMQConsumer::Receive ( const Integer Timeout)
protected

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

Implements IMQConsumer.

◆ ReceiveNoWait()

IMessage TBTMQConsumer::ReceiveNoWait ( )
protected

Receives the next message if one is immediately available.

Implements IMQConsumer.