tortoise v0.9.4 Tortoise.Events View Source

A PubSub exposing various system events from a Tortoise connection. This allows the user to integrate with custom metrics and logging solutions.

Please read the documentation for Tortoise.Events.register/2 for information on how to subscribe to events, and Tortoise.Events.unregister/2 for how to unsubscribe.

Link to this section Summary

Functions

Subscribe to messages on the client with the client id client_id of the type type

unregister(client_id, type)

Unsubscribe from messages of type from client_id. This is the reverse of Tortoise.Events.register/2

Link to this section Functions

register(Tortoise.client_id(), atom()) :: {:ok, pid()} | no_return()

Subscribe to messages on the client with the client id client_id of the type type.

When a message of the subscribed type is dispatched it will end up in the mailbox of the process that placed the subscription. The received message will have the format:

{{Tortoise, client_id}, type, value}

Making it possible to pattern match on multiple message types on multiple clients. The value depends on the message type.

Possible message types are:

:status dispatched when the connection of a client changes status. The value will be :up when the client goes online, and :down when it goes offline.
:ping_response dispatched when the connection receive a response from a keep alive message. The value is the round trip time in milliseconds, and can be used to track the latency over time.

Other message types exist, but unless they are mentioned in the possible message types above they should be considered for internal use only.

It is possible to listen on all events for a given type by specifying :_ as the client_id.

unregister(client_id, type)

unregister(Tortoise.client_id(), atom()) :: :ok | no_return()

Unsubscribe from messages of type from client_id. This is the reverse of Tortoise.Events.register/2.