ExRabbitMQAdmin.Connection (ex_rabbitmq_admin v0.3.0)

Copy Markdown View Source

This module contains functions for interacting with RabbitMQ connections.

Summary

Functions

Close a connection by name.

Close all connections for a specific username.

Get an individual connection by name.

List all channels for a specific connection.

List all open connections.

List all connections for a specific username.

Functions

delete_connection(client, name)

@spec delete_connection(client :: Tesla.Client.t(), name :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

Close a connection by name.

Params

  • client - Tesla client used to perform the request.
  • name - type: string, The name of the connection to close.

delete_user_connections(client, username)

@spec delete_user_connections(client :: Tesla.Client.t(), username :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

Close all connections for a specific username.

Params

  • client - Tesla client used to perform the request.
  • username - type: string, The username to close connections for.

get_connection(client, name)

@spec get_connection(client :: Tesla.Client.t(), name :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

Get an individual connection by name.

Params

  • client - Tesla client used to perform the request.
  • name - type: string, The name of the connection to get.

list_connection_channels(client, name)

@spec list_connection_channels(client :: Tesla.Client.t(), name :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

List all channels for a specific connection.

Params

  • client - Tesla client used to perform the request.
  • name - type: string, The name of the connection to list channels for.

list_connections(client)

@spec list_connections(client :: Tesla.Client.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

List all open connections.

Params

  • client - Tesla client used to perform the request.

list_user_connections(client, username)

@spec list_user_connections(client :: Tesla.Client.t(), username :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

List all connections for a specific username.

Params

  • client - Tesla client used to perform the request.
  • username - type: string, The username to list connections for.