RMQ - RabbitMQ C++ Library
Public Types | Public Member Functions | List of all members
BloombergLP::rmqtestmocks::MockMessageGuard Class Referenceabstract
Inheritance diagram for BloombergLP::rmqtestmocks::MockMessageGuard:
Inheritance graph
[legend]
Collaboration diagram for BloombergLP::rmqtestmocks::MockMessageGuard:
Collaboration graph
[legend]

Public Types

typedef bsl::function< void(const rmqt::ConsumerAck &)> MessageGuardCallback
 

Public Member Functions

 MOCK_CONST_METHOD0 (message, const rmqt::Message &())
 
 MOCK_CONST_METHOD0 (envelope, const rmqt::Envelope &())
 
 MOCK_METHOD0 (ack, void())
 
 MOCK_METHOD1 (nack, void(bool))
 
 MOCK_CONST_METHOD0 (consumer, rmqp::Consumer *())
 
 MOCK_METHOD0 (transferOwnership, rmqp::TransferrableMessageGuard())
 
virtual const rmqt::Messagemessage () const =0
 Access the received message. More...
 
virtual const rmqt::Envelopeenvelope () const =0
 Access the received message envelope (delivery details) More...
 
virtual void ack ()=0
 
virtual void nack (bool requeue=true)=0
 
virtual Consumer * consumer () const =0
 Reference to the Consumer. More...
 
virtual TransferrableMessageGuard transferOwnership ()=0
 

Member Function Documentation

◆ ack()

virtual void BloombergLP::rmqp::MessageGuard::ack ( )
pure virtualinherited

Acknowledge the received message. Callable only once. Should only be called after the message has been fully processed

Implemented in BloombergLP::rmqa::MessageGuard.

◆ consumer()

virtual Consumer * BloombergLP::rmqp::MessageGuard::consumer ( ) const
pure virtualinherited

Reference to the Consumer.

Implemented in BloombergLP::rmqa::MessageGuard.

◆ envelope()

virtual const rmqt::Envelope & BloombergLP::rmqp::MessageGuard::envelope ( ) const
pure virtualinherited

Access the received message envelope (delivery details)

Implemented in BloombergLP::rmqa::MessageGuard.

◆ message()

virtual const rmqt::Message & BloombergLP::rmqp::MessageGuard::message ( ) const
pure virtualinherited

Access the received message.

Implemented in BloombergLP::rmqa::MessageGuard.

◆ nack()

virtual void BloombergLP::rmqp::MessageGuard::nack ( bool  requeue = true)
pure virtualinherited

Negative acknowledge the received message. Callable only once. by default requeues the message on the broker for redelivery, if requeue is false, then the message will be either dead lettered (if a dead letter exchange is specified) or dropped if not.

Implemented in BloombergLP::rmqa::MessageGuard.

◆ transferOwnership()

virtual TransferrableMessageGuard BloombergLP::rmqp::MessageGuard::transferOwnership ( )
pure virtualinherited

Transfers ownership of the message processing to a MessageGuard that is copyable (shared pointer semantics) RETURN a shared pointer to a valid message guard,

Note
if the MessageGuard has already been resolved or transferred (ack/nack) a warning will be printed

Implemented in BloombergLP::rmqa::MessageGuard, and BloombergLP::rmqa::TracingMessageGuard.


The documentation for this class was generated from the following files: