userver: urabbitmq::AdminChannel Class Reference
Loading...
Searching...
No Matches
urabbitmq::AdminChannel Class Referencefinal

#include <userver/urabbitmq/admin_channel.hpp>

Detailed Description

Administrative interface for the broker. You may use this class to setup your exchanges/queues/bindings. You may as well use Client itself instead.

You are not expected to store this class for a long time, because it takes a connection from the underlying connections pool.

Usually retrieved from Client

Definition at line 26 of file admin_channel.hpp.

+ Inheritance diagram for urabbitmq::AdminChannel:
+ Collaboration diagram for urabbitmq::AdminChannel:

Public Member Functions

 AdminChannel (ConnectionPtr &&channel)
 
 AdminChannel (AdminChannel &&other) noexcept
 
void DeclareExchange (const Exchange &exchange, Exchange::Type type, utils::Flags< Exchange::Flags > flags, engine::Deadline deadline) override
 Declare an exchange.
 
void DeclareExchange (const Exchange &exchange, Exchange::Type type, engine::Deadline deadline) override
 overload of DeclareExchange
 
void DeclareExchange (const Exchange &exchange, engine::Deadline deadline) override
 overload of DeclareExchange
 
void DeclareQueue (const Queue &queue, utils::Flags< Queue::Flags > flags, engine::Deadline deadline) override
 Declare a queue.
 
void DeclareQueue (const Queue &queue, engine::Deadline deadline) override
 overload of DeclareQueue
 
void BindQueue (const Exchange &exchange, const Queue &queue, const std::string &routing_key, engine::Deadline deadline) override
 Bind a queue to an exchange.
 
void RemoveExchange (const Exchange &exchange, engine::Deadline deadline) override
 Remove an exchange.
 
void RemoveQueue (const Queue &queue, engine::Deadline deadline) override
 Remove a queue.
 

Member Function Documentation

◆ BindQueue()

void urabbitmq::AdminChannel::BindQueue ( const Exchange & exchange,
const Queue & queue,
const std::string & routing_key,
engine::Deadline deadline )
overridevirtual

Bind a queue to an exchange.

Parameters
exchangethe source exchange
queuethe target queue
routing_keythe routing key
deadlineexecution deadline

Implements urabbitmq::IAdminInterface.

◆ DeclareExchange() [1/3]

void urabbitmq::AdminChannel::DeclareExchange ( const Exchange & exchange,
engine::Deadline deadline )
inlineoverridevirtual

overload of DeclareExchange

Implements urabbitmq::IAdminInterface.

Definition at line 42 of file admin_channel.hpp.

◆ DeclareExchange() [2/3]

void urabbitmq::AdminChannel::DeclareExchange ( const Exchange & exchange,
Exchange::Type type,
engine::Deadline deadline )
inlineoverridevirtual

overload of DeclareExchange

Implements urabbitmq::IAdminInterface.

Definition at line 37 of file admin_channel.hpp.

◆ DeclareExchange() [3/3]

void urabbitmq::AdminChannel::DeclareExchange ( const Exchange & exchange,
Exchange::Type type,
utils::Flags< Exchange::Flags > flags,
engine::Deadline deadline )
overridevirtual

Declare an exchange.

Parameters
exchangename of the exchange
typeexchange type
flagsexchange flags
deadlineexecution deadline

Implements urabbitmq::IAdminInterface.

◆ DeclareQueue() [1/2]

void urabbitmq::AdminChannel::DeclareQueue ( const Queue & queue,
engine::Deadline deadline )
inlineoverridevirtual

overload of DeclareQueue

Implements urabbitmq::IAdminInterface.

Definition at line 50 of file admin_channel.hpp.

◆ DeclareQueue() [2/2]

void urabbitmq::AdminChannel::DeclareQueue ( const Queue & queue,
utils::Flags< Queue::Flags > flags,
engine::Deadline deadline )
overridevirtual

Declare a queue.

Parameters
queuename of the queue
flagsqueue flags
deadlineexecution deadline

Implements urabbitmq::IAdminInterface.

◆ RemoveExchange()

void urabbitmq::AdminChannel::RemoveExchange ( const Exchange & exchange,
engine::Deadline deadline )
overridevirtual

Remove an exchange.

Parameters
exchangename of the exchange to remove
deadlineexecution deadline

Implements urabbitmq::IAdminInterface.

◆ RemoveQueue()

void urabbitmq::AdminChannel::RemoveQueue ( const Queue & queue,
engine::Deadline deadline )
overridevirtual

Remove a queue.

Parameters
queuename of the queue to remove
deadlineexecution deadline

Implements urabbitmq::IAdminInterface.


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