Express v1.0.0 Express.Application View Source

Sets up Express’s supervision tree.

Link to this section Summary

Functions

Returns the name of the APNS supervisors pool

Returns poolboy config of APNS supervisors pool. If poolboy config was overriden in config.exs - returns it, default config will be returned otherwise

Returns the name of the FCM supervisors pool

Returns poolboy config of FCM supervisors pool. If poolboy config was overriden in config.exs - returns it, default config will be returned otherwise

Called when an application is started

Link to this section Functions

Link to this function apns_pool_name() View Source
apns_pool_name() :: atom

Returns the name of the APNS supervisors pool.

Link to this function apns_poolboy_config() View Source
apns_poolboy_config() :: Keyword.t

Returns poolboy config of APNS supervisors pool. If poolboy config was overriden in config.exs - returns it, default config will be returned otherwise.

Link to this function fcm_pool_name() View Source
fcm_pool_name() :: atom

Returns the name of the FCM supervisors pool.

Link to this function fcm_poolboy_config() View Source
fcm_poolboy_config() :: Keyword.t

Returns poolboy config of FCM supervisors pool. If poolboy config was overriden in config.exs - returns it, default config will be returned otherwise.

Called when an application is started.

This function is called when an the 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 mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., 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.