urabbitmq::AdminChannel Class Reference

Table of Contents

• Detailed Description
• Public Member Functions
• Member Function Documentation
• BindQueue()
• DeclareExchange() [1/3]
• DeclareExchange() [2/3]
• DeclareExchange() [3/3]
• DeclareQueue() [1/2]
• DeclareQueue() [2/2]
• RemoveExchange()
• RemoveQueue()

#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

exchange	the source exchange
queue	the target queue
routing_key	the routing key
deadline	execution 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

exchange	name of the exchange
type	exchange type
flags	exchange flags
deadline	execution 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

queue	name of the queue
flags	queue flags
deadline	execution deadline

Implements urabbitmq::IAdminInterface.

RemoveExchange()

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

overridevirtual

Remove an exchange.

Parameters

exchange	name of the exchange to remove
deadline	execution deadline

Implements urabbitmq::IAdminInterface.

RemoveQueue()

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

overridevirtual

Remove a queue.

Parameters

queue	name of the queue to remove
deadline	execution deadline

Implements urabbitmq::IAdminInterface.

---

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

• userver/urabbitmq/admin_channel.hpp