Phoenix.PubSub.Application
Summary
Functions
- start(_, _)
Called when an application is started.
Functions
start(_, _)
Called when an application is started.
This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application's supervision tree if the application follows the OTP design principles around supervision).
start_type defines how the application is started:
-
:normal- used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key:start_phasesis:undefined. -
{:takeover, node}- used if the application is distributed and is started on the current node because of a failover on the nodenode. -
{:failover, node}- used if the application is distributed and is started on the current node because of a failover on nodenode, and the application specification key:start_phasesis not:undefined.
start_args are the arguments passed to the application in the :mod specification key (for example, mod: {MyApp, [:my_args]}).
This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).
use Application provides no default implementation for the start/2 callback.
Callback implementation for Application.start/2.
© 2014 Chris McCord
Licensed under the MIT License.
https://hexdocs.pm/phoenix_pubsub/Phoenix.PubSub.Application.html