tortoise

v0.10.0

tortoise v0.10.0 Tortoise.Supervisor View Source

A dynamic supervisor that can hold Tortoise.Connection processes

A Tortoise.Supervisor, registered under the name Tortoise.Supervisor, is started as part of the Tortoise.App, which will get started automatically when Tortoise is included as a Mix dependency. Spawning a connection on the Tortoise.Supervisor can be done as follows:

{:ok, pid} =
  Tortoise.Supervisor.start_child(
    client_id: T1000,
    handler: {Tortoise.Handler.Logger, []},
    server: {Tortoise.Transport.Tcp, host: 'localhost', port: 1883},
    subscriptions: [{"foo/bar", 0}]
  )

While this is an easy way to get started one should consider the supervision strategy of the application using the Tortoise.Connections. Often one would like to close the connection with the application using the connection, in which case one could consider starting the Tortoise.Connection directly in the supervisor of the application using the connection, or start a Tortoise.Supervisor as part of ones application if it require more than one connection.

See the Connection Supervision article in the project documentation for more information on connection supervision.

Link to this section Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

start_child(supervisor \\ __MODULE__, opts)

Start a connection as a child of the Tortoise.Supervisor

start_link(opts)

Start a dynamic supervisor that can hold connection processes

Link to this section Functions

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function start_child(supervisor \\ __MODULE__, opts) View Source

Start a connection as a child of the Tortoise.Supervisor.

supervisor is the name of the supervisor the child should be started on, and it defaults to Tortoise.Supervisor.

Link to this function start_link(opts) View Source

Start a dynamic supervisor that can hold connection processes.

The :name option can also be given in order to register a supervisor name, the supported values are described in the “Name registration” section in the GenServer module docs.