Mocks rmqp::Producer and/or rmqa::Producer. More...

#include <rmqtestmocks_mockproducer.h>

Inheritance diagram for BloombergLP::rmqtestmocks::MockProducer:

Collaboration diagram for BloombergLP::rmqtestmocks::MockProducer:

Public Types
enum	SendStatus { SENDING , DUPLICATE , TIMEOUT , INFLIGHT_LIMIT , TRANSFORM_ERROR }
	Possible results of rmqp::Producer::send.

typedef bsl::function< void(const rmqt::Message &, const bsl::string &routingKey, const rmqt::ConfirmResponse &)>	ConfirmationCallback
	Invoked on receipt of message confirmation. More...

Public Member Functions
bsl::shared_ptr< rmqa::Producer >	producer ()

rmqt::Result< rmqp::Producer >	success ()

rmqt::Future< rmqp::Producer >	successAsync ()

	MOCK_METHOD1 (addTransformer, void(const bsl::shared_ptr< rmqp::MessageTransformer > &transformer))

	MOCK_METHOD4 (send, rmqp::Producer::SendStatus(const rmqt::Message &message, const bsl::string &routingKey, const rmqp::Producer::ConfirmationCallback &confirmCallback, const bsls::TimeInterval &timeout))

	MOCK_METHOD5 (send, rmqp::Producer::SendStatus(const rmqt::Message &message, const bsl::string &routingKey, rmqt::Mandatory::Value mandatory, const rmqp::Producer::ConfirmationCallback &confirmCallback, const bsls::TimeInterval &timeout))

	MOCK_METHOD3 (trySend, rmqp::Producer::SendStatus(const rmqt::Message &message, const bsl::string &routingKey, const rmqp::Producer::ConfirmationCallback &confirmCallback))

	MOCK_METHOD1 (waitForConfirms, rmqt::Result<>(const bsls::TimeInterval &))

	MOCK_METHOD2 (updateTopology, rmqt::Result<>(const rmqt::TopologyUpdate &, const bsls::TimeInterval &))

	MOCK_METHOD1 (updateTopologyAsync, rmqt::Future<>(const rmqt::TopologyUpdate &))

virtual void	addTransformer (const bsl::shared_ptr< rmqp::MessageTransformer > &transformer)=0
	Adds a transformation function to be run on all messages. More...

virtual SendStatus	send (const rmqt::Message &message, const bsl::string &routingKey, const rmqp::Producer::ConfirmationCallback &confirmCallback, const bsls::TimeInterval &timeout)=0
	Send a message with the given `routingKey` to the exchange targeted by the producer. More...

virtual SendStatus	send (const rmqt::Message &message, const bsl::string &routingKey, rmqt::Mandatory::Value mandatoryFlag, const rmqp::Producer::ConfirmationCallback &confirmCallback, const bsls::TimeInterval &timeout)=0
	Send a message with the given `routingKey` to the exchange targeted by the producer. More...

virtual SendStatus	trySend (const rmqt::Message &message, const bsl::string &routingKey, const rmqp::Producer::ConfirmationCallback &confirmCallback)=0
	Send a message with the given `routingKey` to the exchange targeted by the producer. More...

virtual rmqt::Result	waitForConfirms (const bsls::TimeInterval &timeout)=0
	Wait for all outstanding publisher confirms to arrive. More...

virtual rmqt::Future	updateTopologyAsync (const rmqt::TopologyUpdate &topologyUpdate)=0
	Updates topology. More...

Static Public Member Functions
static rmqt::Result< rmqp::Producer >	timeout ()

static rmqt::Result< rmqp::Producer >	error ()

static rmqt::Future< rmqp::Producer >	timeoutAsync ()

static rmqt::Future< rmqp::Producer >	errorAsync ()

Detailed Description

Mocks rmqp::Producer and/or rmqa::Producer.

Member Typedef Documentation

◆ ConfirmationCallback

typedef bsl::function<void(const rmqt::Message&, const bsl::string& routingKey, const rmqt::ConfirmResponse&)> BloombergLP::rmqp::Producer::ConfirmationCallback

inherited

Invoked on receipt of message confirmation.

The user-provided ConfirmationCallback is invoked once RabbitMQ broker provides a guarantee (publisher confirm) that the message is enqueued.

A ConfirmationCallback implementation should perform any commit action, such as confirming to the sender of the message that the action will be completed. For example, an application which consumes from one queue and produces to another should send the acknowledgement to the first queue once the ConfirmationCallback is invoked from the publish.

Member Function Documentation

◆ addTransformer()

virtual void BloombergLP::rmqp::Producer::addTransformer ( const bsl::shared_ptr< rmqp::MessageTransformer > & transformer )

pure virtualinherited

Adds a transformation function to be run on all messages.

Parameters

transformer The transformation function

◆ send() [1/2]

virtual SendStatus BloombergLP::rmqp::Producer::send	(	const rmqt::Message &	message,
		const bsl::string &	routingKey,
		const rmqp::Producer::ConfirmationCallback &	confirmCallback,
		const bsls::TimeInterval &	timeout
	)

pure virtualinherited

Send a message with the given routingKey to the exchange targeted by the producer.

The behavior of this method depends on the the number of unconfirmed messages (sent but not yet confirmed by the broker). If this number is smaller than the limit configured when calling rmqa::VHost::createProducer, this method will return immediately. Otherwise it will block until the unconfirmed message count drops below the limit.

Parameters

message	The message to be sent.
routingKey	The routing key (e.g. topic or queue name) passed to the exchange.
confirmCallback	Called when the broker explicitly confirms/rejects the message. Messages are automatically retried on reconnection, in which case this method may be called some time after invoking `send`.
timeout	How long to wait for as a relative timeout. If timeout is 0, the method will wait to send message indefinitely

Returns: SENDING Returned when the library accepts the message for sending. If the connection is lost before receiving the publisher confirm from the broker, the library will retry sending the message.; DUPLICATE Returned if a message with the same GUID has already been sent and is awaiting a confirm from the broker. This indicates an issue with the application. To send the same message multiple times, a new rmqt::Message object must be created every time.; TIMEOUT Returned if a message couldn't be enqueued within the timeout time.

Implemented in BloombergLP::rmqa::ProducerImpl, and BloombergLP::rmqa::TracingProducerImpl.

◆ send() [2/2]

virtual SendStatus BloombergLP::rmqp::Producer::send	(	const rmqt::Message &	message,
		const bsl::string &	routingKey,
		rmqt::Mandatory::Value	mandatoryFlag,
		const rmqp::Producer::ConfirmationCallback &	confirmCallback,
		const bsls::TimeInterval &	timeout
	)

pure virtualinherited

Send a message with the given routingKey to the exchange targeted by the producer.

The behavior of this method depends on the the number of unconfirmed messages (sent but not yet confirmed by the broker). If this number is smaller than the limit configured when calling rmqa::VHost::createProducer, this method will return immediately. Otherwise it will block until the unconfirmed message count drops below the limit.

Parameters

message	The message to be sent.
routingKey	The routing key (e.g. topic or queue name) passed to the exchange.
mandatory	Specify the mandatory flag: RETURN_UNROUTABLE (Recommended): Any messages not passed to a queue are returned to the sender. confirmCallback will be invoked with a RETURN status. DISCARD_UNROUTABLE (Dangerous): Any messages not passed to a queue are confirmed by the broker. This will cause silent message loss in the event bindings aren't setup as expected.
confirmCallback	Called when the broker explicitly confirms/rejects the message. Messages are automatically retried on reconnection, in which case this method may be called some time after invoking `send`.
timeout	How long to wait for as a relative timeout. If timeout is 0, the method will wait to send message indefinitely

Returns: SENDING Returned when the library accepts the message for sending. If the connection is lost before receiving the publisher confirm from the broker, the library will retry sending the message.; DUPLICATE Returned if a message with the same GUID has already been sent and is awaiting a confirm from the broker. This indicates an issue with the application. To send the same message multiple times, a new rmqt::Message object must be created every time.; TIMEOUT Returned if a message couldn't be enqueued within the timeout time.

Implemented in BloombergLP::rmqa::ProducerImpl.

◆ trySend()

rmqp::Producer::SendStatus BloombergLP::rmqa::Producer::trySend	(	const rmqt::Message &	message,
		const bsl::string &	routingKey,
		const rmqp::Producer::ConfirmationCallback &	confirmCallback
	)

pure virtualinherited

Send a message with the given routingKey to the exchange targeted by the producer.

The behavior of this method depends on the the number of unconfirmed messages (sent but not yet confirmed by the broker). If this number is smaller than the limit configured when calling rmqa::VHost::createProducer, this method behaves exactly as the method send. Otherwise, unlike send, this method returns immediately with a result indicating that the unconfirmed message limit has been reached.

Parameters

message	The message to be sent.
routingKey	The routing key (e.g. topic or queue name) passed to the exchange.
confirmCallback	Called when the broker explicitly confirms/rejects the message. Messages are automatically retried on reconnection, in which case this method may be called some time after invoking `send`.

Returns: SENDING Returned when the library accepts the message for sending. If the connection is lost before receiving the publisher confirm from the broker, the library will retry sending the message.; DUPLICATE Returned if a message with the same GUID has already been sent and is awaiting a confirm from the broker. This indicates an issue with the application. To send the same message multiple times, a new rmqt::Message object must be created every time.; INFLIGHT_LIMIT Returned if the unconfirmed message limit has been reached.

Implemented in BloombergLP::rmqa::ProducerImpl, and BloombergLP::rmqa::TracingProducerImpl.

◆ updateTopologyAsync()

virtual rmqt::Future BloombergLP::rmqp::Producer::updateTopologyAsync ( const rmqt::TopologyUpdate & topologyUpdate )

pure virtualinherited

Updates topology.

Returns: A Future which, when resolved, will contain the result of the update.

Implemented in BloombergLP::rmqa::ProducerImpl.

◆ waitForConfirms()

virtual rmqt::Result BloombergLP::rmqp::Producer::waitForConfirms ( const bsls::TimeInterval & timeout )

pure virtualinherited

Wait for all outstanding publisher confirms to arrive.

This method allows

Parameters

timeout How long to wait for. If timeout is 0, the method will wait for confirms indefinitely.

Returns: true if all outstanding confirms have arrived.; false if waiting timed out.

Implemented in BloombergLP::rmqa::ProducerImpl.

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

src/rmqtestmocks/rmqtestmocks_mockproducer.h
src/rmqtestmocks/rmqtestmocks_mockproducer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ConfirmationCallback

Member Function Documentation

◆ addTransformer()

◆ send() [1/2]

◆ send() [2/2]

◆ trySend()

◆ updateTopologyAsync()

◆ waitForConfirms()