greyhound v0.1.0 Greyhound.Supervisor

Primary supervisor used to start a bus.

This module will most likely not be used directly. The Greyhound.Bus macro is responsible for starting this supervisor. However, in instances where you would like to use a bus without the help of Greyhound.Bus you can manually add this supervisor to your superivision tree

Required Options

  • :middleware - a list of middleware modules used to process dispatched events
  • :otp_app - an atom of the OTP app this bus belongs to. This is primarily used for grabbing values from the application config. (e.g. :my_app)
  • :server - an atom used to identify a bus. This value is used to send messages to a specific bus. If you would like to run multiple busses simultaneously make sure this value is different for each supervisor. (e.g. MyApp.Bus)

See Greyhound for details on using a bus directly.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Starts a bus and links it to the current process

Link to this section Functions

Link to this function child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function start_link(opts)
start_link(Keyword.t()) :: Supervisor.on_start()

Starts a bus and links it to the current process.