urabbitmq::IAdminInterface 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/broker_interface.hpp>

Detailed Description

Administrative interface for the broker. This class is merely an interface for convenience and you are not expected to use it directly (use Client/AdminChannel instead).

Definition at line 20 of file broker_interface.hpp.

Inheritance diagram for urabbitmq::IAdminInterface:

Public Member Functions
virtual void	DeclareExchange (const Exchange &exchange, Exchange::Type type, utils::Flags< Exchange::Flags > flags, engine::Deadline deadline)=0
	Declare an exchange.
virtual void	DeclareExchange (const Exchange &exchange, Exchange::Type type, engine::Deadline deadline)=0
	overload of DeclareExchange
virtual void	DeclareExchange (const Exchange &exchange, engine::Deadline deadline)=0
	overload of DeclareExchange
virtual void	DeclareQueue (const Queue &queue, utils::Flags< Queue::Flags > flags, engine::Deadline deadline)=0
	Declare a queue.
virtual void	DeclareQueue (const Queue &queue, engine::Deadline deadline)=0
	overload of DeclareQueue
virtual void	BindQueue (const Exchange &exchange, const Queue &queue, const std::string &routing_key, engine::Deadline deadline)=0
	Bind a queue to an exchange.
virtual void	RemoveExchange (const Exchange &exchange, engine::Deadline deadline)=0
	Remove an exchange.
virtual void	RemoveQueue (const Queue &queue, engine::Deadline deadline)=0
	Remove a queue.

Member Function Documentation

BindQueue()

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

pure virtual

Bind a queue to an exchange.

Parameters

exchange	the source exchange
queue	the target queue
routing_key	the routing key
deadline	execution deadline

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

DeclareExchange() [1/3]

virtual void urabbitmq::IAdminInterface::DeclareExchange ( const Exchange & exchange, engine::Deadline deadline )

pure virtual

overload of DeclareExchange

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

DeclareExchange() [2/3]

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

pure virtual

overload of DeclareExchange

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

DeclareExchange() [3/3]

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

pure virtual

Declare an exchange.

Parameters

exchange	name of the exchange
type	exchange type
flags	exchange flags
deadline	execution deadline

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

DeclareQueue() [1/2]

virtual void urabbitmq::IAdminInterface::DeclareQueue ( const Queue & queue, engine::Deadline deadline )

pure virtual

overload of DeclareQueue

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

DeclareQueue() [2/2]

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

pure virtual

Declare a queue.

Parameters

queue	name of the queue
flags	queue flags
deadline	execution deadline

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

RemoveExchange()

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

pure virtual

Remove an exchange.

Parameters

exchange	name of the exchange to remove
deadline	execution deadline

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

RemoveQueue()

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

pure virtual

Remove a queue.

Parameters

queue	name of the queue to remove
deadline	execution deadline

Implemented in urabbitmq::AdminChannel, and urabbitmq::Client.

---

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

• userver/urabbitmq/broker_interface.hpp