Module us_main_app

The main entry point of the US-Main (Universal Server) active OTP application.

Behaviours: application.

Description

The main entry point of the US-Main (Universal Server) active OTP application.

Typically triggered:

- through OTP/rebar3, by ebin/us_main.app (as obtained from conf/us_main.app.src; see start/2)

- directly, with the help of Myriad's otp_utils (see exec/0)

Data Types

application_name()

application_name() = otp_utils:application_name()

Function Index

exec/0Runs US-Main, directly (ex: as 'make us_main_exec') rather than as an OTP release.
start/2Called when US-Main itself is started as an OTP release (as opposed to natively, "manually", see exec/0).
start_application/1Starts required applications (not used currently).
stop/1Stops the US-Main application.

Function Details

exec/0

exec() -> void()

Runs US-Main, directly (ex: as 'make us_main_exec') rather than as an OTP release.

start/2

start(StartType, StartArgs) -> any()

Called when US-Main itself is started as an OTP release (as opposed to natively, "manually", see exec/0).

The setup and dependency management shall have been done already by the OTP release system. So here no ebin path to set or prerequisite applications to start for applications listed in US-Main's .app file, we focus only on the applications not listed whereas possibly useful in this context and on us_main itself.

Note that it may easier/more reliable to add these applications directly in the OTP release / rebar configuration.

start_application/1

start_application(App::application_name()) -> void()

Starts required applications (not used currently).

stop/1

stop(State) -> any()

Stops the US-Main application.


Generated by EDoc