BloombergLP::rmqp::MessageGuard Class Reference

An interface for MessageGuard class. More...

#include <rmqp_messageguard.h>

Inheritance diagram for BloombergLP::rmqp::MessageGuard:

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

Public Member Functions
virtual const rmqt::Message &	message () const =0
	Access the received message. More...
virtual const rmqt::Envelope &	envelope () 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

Detailed Description

An interface for MessageGuard class.

Received messages are passed to consumers with MessageGuard objects. A message guard provides access to the received message and methods for acknowledging (or nack'ing) it. This interface is provided for testing purposes.

Constructor & Destructor Documentation

~MessageGuard()

BloombergLP::rmqp::MessageGuard::~MessageGuard ( )

virtual

Reimplemented in BloombergLP::rmqa::MessageGuard.

Member Function Documentation

ack()

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

pure virtual

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 virtual

Reference to the Consumer.

Implemented in BloombergLP::rmqa::MessageGuard.

envelope()

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

pure virtual

Access the received message envelope (delivery details)

Implemented in BloombergLP::rmqa::MessageGuard.

message()

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

pure virtual

Access the received message.

Implemented in BloombergLP::rmqa::MessageGuard.

nack()

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

pure virtual

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 virtual

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:

• src/rmq/rmqp/rmqp_messageguard.h
• src/rmq/rmqp/rmqp_messageguard.cpp