userver: userver/rabbitmq.hpp Source File
Loading...
Searching...
No Matches
rabbitmq.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file userver/rabbitmq.hpp
4/// This file is mainly for documentation purposes and inclusion of all headers
5/// that are required for working with RabbitMQ userver component.
6
7#include <userver/urabbitmq/admin_channel.hpp>
8#include <userver/urabbitmq/broker_interface.hpp>
9#include <userver/urabbitmq/channel.hpp>
10#include <userver/urabbitmq/client.hpp>
11#include <userver/urabbitmq/client_settings.hpp>
12#include <userver/urabbitmq/component.hpp>
13#include <userver/urabbitmq/consumer_base.hpp>
14#include <userver/urabbitmq/consumer_component_base.hpp>
15#include <userver/urabbitmq/consumer_settings.hpp>
16#include <userver/urabbitmq/typedefs.hpp>
17
18/// @page rabbitmq_driver RabbitMQ (AMQP 0-9-1) - EXPERIMENTAL
19///
20/// Disclaimer: current state of the driver is experimental, and
21/// although APIs are not likely to change drastically, some adjustments may be
22/// made in the future.
23/// Please also keep in mind that this driver is
24/// not backed by Yandex-scale production usage.
25///
26/// 🐙 **userver** provides access to RabbitMQ servers via
27/// components::RabbitMQ. The uRabbitMQ driver is asynchronous, it suspends
28/// current coroutine for carrying out network I/O.
29///
30/// @section feature Features
31/// - Publishing messages;
32/// - Consuming messages;
33/// - Creating Exchanges, Queues and Bindings;
34/// - Transport level security;
35/// - Connections pooling;
36/// - End-to-end logging for messages in publish->consume chain.
37///
38/// @section info More information
39/// - For configuration see components::RabbitMQ
40/// - For cluster operations see urabbitmq::Client, urabbitmq::AdminChannel,
41/// urabbitmq::Channel, urabbitmq::ReliableChannel
42/// - For consumers support see urabbitmq::ConsumerBase and
43/// urabbitmq::ConsumerComponentBase
44///
45/// ----------
46///
47/// @htmlonly <div class="bottom-nav"> @endhtmlonly
48/// ⇦ @ref scripts/docs/en/userver/grpc.md |
49/// @ref scripts/docs/en/userver/dynamic_config.md ⇨
50/// @htmlonly </div> @endhtmlonly
51
52USERVER_NAMESPACE_BEGIN
53
54namespace urabbitmq {
55/// @brief top namespace for uRabbitMQ driver.
56///
57/// For more information see @ref rabbitmq_driver.
58}
59
60USERVER_NAMESPACE_END