Module kyu_management

This module provides an interface to communicate with the RabbitMQ management HTTP API.

Description

This module provides an interface to communicate with the RabbitMQ management HTTP API.

Data Types

method()

method() = get | post

response()

response() = {ok, map() | list()} | {error, integer(), binary()} | {error, term()}

route()

route() = string() | {string(), list()}

Function Index

get_queue/2Returns details about the provided queue.
get_queue_bindings/2Returns the bindings declared on the provided queue.
get_queue_bindings/3Returns the bindings in an exchange declared on the provided queue.
get_queues/1Returns the queues declared on the provided connection.
request/3Equivalent to kyu_management:request(Method, Connection, Route, <<>>).
request/4Makes a request to the RabbitMQ management HTTP API.

Function Details

get_queue/2

get_queue(Connection::kyu_connection:name(), Queue::binary()) -> response()

Returns details about the provided queue. This function respects the virtual_host option of the connection.

get_queue_bindings/2

get_queue_bindings(Connection::kyu_connection:name(), Queue::binary()) -> response()

Returns the bindings declared on the provided queue. This function respects the virtual_host option of the connection.

get_queue_bindings/3

get_queue_bindings(Connection::kyu_connection:name(), Queue::binary(), Exchange::binary()) -> response()

Returns the bindings in an exchange declared on the provided queue. This function respects the virtual_host option of the connection.

get_queues/1

get_queues(Connection::kyu_connection:name()) -> response()

Returns the queues declared on the provided connection. This function respects the virtual_host option of the connection.

request/3

request(Method::method(), Connection::kyu_connection:name(), Route::route()) -> response()

Equivalent to kyu_management:request(Method, Connection, Route, <<>>).

request/4

request(Method::method(), Connection::kyu_connection:name(), Route::route(), Body::map() | list() | binary()) -> response()

Makes a request to the RabbitMQ management HTTP API.


Generated by EDoc