RMQ - RabbitMQ C++ Library
rmqa_consumerimpl.h
1// Copyright 2020-2023 Bloomberg Finance L.P.
2// SPDX-License-Identifier: Apache-2.0
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16#ifndef INCLUDED_RMQA_CONSUMERIMPL
17#define INCLUDED_RMQA_CONSUMERIMPL
18
19#include <rmqa_messageguard.h>
20
21#include <rmqio_eventloop.h>
22#include <rmqp_consumer.h>
23#include <rmqp_messagetransformer.h>
24#include <rmqt_consumerackbatch.h>
25#include <rmqt_endpoint.h>
26#include <rmqt_envelope.h>
27#include <rmqt_message.h>
28#include <rmqt_queue.h>
29#include <rmqt_result.h>
30
31#include <bdlmt_threadpool.h>
32#include <bslmt_lockguard.h>
33#include <bslmt_mutex.h>
34#include <bsls_keyword.h>
35
36#include <bsl_functional.h>
37#include <bsl_memory.h>
38#include <bsl_string.h>
39#include <bsl_vector.h>
40
41//@PURPOSE: Provide a RabbitMQ Async Consumer API
42//
43//@CLASSES:
44// rmqa::Consumer: a RabbitMQ Async Consumer object
45
46namespace BloombergLP {
47
48namespace rmqamqp {
49class ReceiveChannel;
50}
51
52namespace rmqa {
53
55 public bsl::enable_shared_from_this<ConsumerImpl> {
56 public:
57 class Factory {
58 public:
59 virtual ~Factory();
60 virtual bsl::shared_ptr<ConsumerImpl>
61 create(const bsl::shared_ptr<rmqamqp::ReceiveChannel>& channel,
62 rmqt::QueueHandle queue,
63 const bsl::shared_ptr<ConsumerFunc>& onMessage,
64 const bsl::string& consumerTag,
65 bdlmt::ThreadPool& threadPool,
66 rmqio::EventLoop& eventLoop,
67 const bsl::shared_ptr<rmqt::ConsumerAckQueue>& ackQueue,
68 const bsl::vector<bsl::shared_ptr<rmqp::MessageTransformer> >&
69 transformers) const;
70 };
71
72 // CREATORS
74 const bsl::shared_ptr<rmqamqp::ReceiveChannel>& channel,
75 rmqt::QueueHandle queue,
76 const bsl::shared_ptr<ConsumerFunc>& onMessage,
77 const bsl::string& consumerTag,
78 bdlmt::ThreadPool& threadPool,
79 rmqio::EventLoop& eventLoop,
80 const bsl::shared_ptr<rmqt::ConsumerAckQueue>& ackQueue,
81 const bsl::shared_ptr<rmqa::MessageGuard::Factory>& messageGuardFactory,
82 const bsl::vector<bsl::shared_ptr<rmqp::MessageTransformer> >&
83 transformers);
84
87
88 rmqt::Result<> start();
89
91 rmqt::Future<> cancel() BSLS_KEYWORD_OVERRIDE;
92
95 rmqt::Future<> drain() BSLS_KEYWORD_OVERRIDE;
96
97 rmqt::Result<>
98 cancelAndDrain(const bsls::TimeInterval& timeout) BSLS_KEYWORD_OVERRIDE;
99
100 rmqt::Future<> updateTopologyAsync(
101 const rmqt::TopologyUpdate& topologyUpdate) BSLS_KEYWORD_OVERRIDE;
102
103 private:
104 ConsumerImpl(const ConsumerImpl&) BSLS_KEYWORD_DELETED;
105 ConsumerImpl& operator=(const ConsumerImpl&) BSLS_KEYWORD_DELETED;
106
107 void ackMessage(const rmqt::ConsumerAck& ack);
108
109 bool unpackTransformations(rmqt::Message& dstMessage,
110 const rmqt::Message& srcMessage);
111
114 static void
115 handleMessage(const bsl::weak_ptr<ConsumerImpl>& consumerWeakPtr,
116 bdlmt::ThreadPool& threadPool,
117 const rmqt::Message& message,
118 const rmqt::Envelope& envelope);
119
120 static void
121 threadPoolHandleMessage(const bsl::weak_ptr<ConsumerImpl>& consumer,
122 const rmqt::Message& message,
123 const rmqt::Envelope& envelope);
124
125 static void messageGuardCb(const bsl::weak_ptr<ConsumerImpl>& consumerPtr,
126 const rmqt::ConsumerAck& ack);
127
128 private:
129 bsl::string d_consumerTag;
130 rmqt::QueueHandle d_queue;
131 bsl::shared_ptr<rmqp::Consumer::ConsumerFunc> d_onMessage;
132 bdlmt::ThreadPool& d_threadPool;
133 rmqio::EventLoop& d_eventLoop;
134 bsl::shared_ptr<rmqt::ConsumerAckQueue> d_ackQueue;
135 bsl::shared_ptr<rmqt::ConsumerAckBatch> d_ackBatch;
136 bslmt::Mutex d_ackMessageMutex;
137
138 bsl::shared_ptr<rmqamqp::ReceiveChannel> d_channel;
139 bsl::shared_ptr<MessageGuard::Factory> d_guardFactory;
140 bsl::vector<bsl::shared_ptr<rmqp::MessageTransformer> > d_transformers;
141
142 bsl::function<void()> d_onNewAckBatch;
143 bsl::function<void(const rmqt::ConsumerAck&)> d_messageGuardCb;
144}; // class ConsumerImpl
145
146} // namespace rmqa
147} // namespace BloombergLP
148
149#endif // ! INCLUDED_RMQA_CONSUMERIMPL
Definition: rmqa_consumerimpl.h:57
Definition: rmqa_consumerimpl.h:55
rmqt::Future cancel() BSLS_KEYWORD_OVERRIDE
Cancels the consumer, stops new messages flowing in.
Definition: rmqa_consumerimpl.cpp:145
rmqt::Future drain() BSLS_KEYWORD_OVERRIDE
Definition: rmqa_consumerimpl.cpp:151
~ConsumerImpl()
Destructor stops the consumer.
Definition: rmqa_consumerimpl.cpp:99
rmqt::Result cancelAndDrain(const bsls::TimeInterval &timeout) BSLS_KEYWORD_OVERRIDE
Tells the broker to stop delivering messages to this consumer.
Definition: rmqa_consumerimpl.cpp:157
rmqt::Future updateTopologyAsync(const rmqt::TopologyUpdate &topologyUpdate) BSLS_KEYWORD_OVERRIDE
Updates topology.
Definition: rmqa_consumerimpl.cpp:168
Provide a RabbitMQ Async Consumer API.
Definition: rmqa_consumer.h:41
Controls acknowledgements passed to broker for consumed messages.
Definition: rmqa_messageguard.h:45
Definition: rmqa_topologyupdate.h:27
Provide a RabbitMQ Async Consumer API.
Definition: rmqp_consumer.h:38
bsl::function< void(rmqp::MessageGuard &)> ConsumerFunc
Callback function used to receive messages.
Definition: rmqp_consumer.h:48
An async-style Future/Promise object.
Definition: rmqt_future.h:108
A result of an operation.
Definition: rmqt_result.h:37