roger v2.4.1 Roger.AMQPClient View Source

Worker process which holds the AMQP connection.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Closes the AMQP connection

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Open a channel to RabbitMQ and return it. This also links the calling process to the connection

Publishes a message to RabbitMQ

Starts the client and connects to RabbitMQ

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Closes the AMQP connection.

This will cause all running Roger partitions to shut down. They will be retried until the connection comes up again.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Open a channel to RabbitMQ and return it. This also links the calling process to the connection.

Link to this function publish(exchange, routing_key, payload, opts \\ []) View Source

Publishes a message to RabbitMQ.

The AMQP client automatically opens a single channel dedicated for sending messages.

Starts the client and connects to RabbitMQ.