View Source Yggdrasil.Subscriber.Generator (Yggdrasil v6.0.2)

Supervisor to generate distributors on demand.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Starts a distributor generator with Supervisor options.

Stops a distributor generator.

Makes a pid subscribe to a channel.

Makes a pid unsubscribe from a channel.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

start_link(options \\ [])

View Source

Specs

Starts a distributor generator with Supervisor options.

Specs

stop(Supervisor.supervisor()) :: :ok

Stops a distributor generator.

Link to this function

subscribe(channel, pid \\ nil, options \\ [])

View Source

Specs

subscribe(Yggdrasil.Channel.t(), nil | pid(), keyword()) ::
  :ok | {:error, term()}

Makes a pid subscribe to a channel.

Link to this function

unsubscribe(channel, pid \\ nil)

View Source

Specs

unsubscribe(Yggdrasil.Channel.t(), nil | pid()) :: :ok | {:error, term()}

Makes a pid unsubscribe from a channel.