Yggdrasil v5.0.0 Yggdrasil.Subscriber.Generator View Source
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
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_link(options \\ [])
View Source
start_link(options \\ [])
View Source
start_link(DynamicSupervisor.options()) :: Supervisor.on_start()
start_link(DynamicSupervisor.options()) :: Supervisor.on_start()
Starts a distributor generator with Supervisor
options
.
Link to this function
stop(generator)
View Source
stop(generator)
View Source
stop(Supervisor.supervisor()) :: :ok
stop(Supervisor.supervisor()) :: :ok
Stops a distributor generator
.
Link to this function
subscribe(channel, pid \\ nil, options \\ [])
View Source
subscribe(channel, pid \\ nil, options \\ [])
View Source
subscribe(Yggdrasil.Channel.t(), pid(), Keyword.t()) :: :ok | {:error, term()}
subscribe(Yggdrasil.Channel.t(), pid(), Keyword.t()) :: :ok | {:error, term()}
Makes a pid
subscribe to a channel
.
Link to this function
unsubscribe(channel, pid \\ nil)
View Source
unsubscribe(channel, pid \\ nil)
View Source
unsubscribe(Yggdrasil.Channel.t(), pid()) :: :ok
unsubscribe(Yggdrasil.Channel.t(), pid()) :: :ok
Makes a pid
unsubscribe from a channel
.