Membrane Core v0.5.0 Membrane.Log.Logger View Source

Module containing functions spawning, shutting down, and handling messages sent to logger.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Stops given logger process.

Starts process for logger of given module, initialized with given options outside of the supervision tree.

Starts process for logger of given module, initialized with given options and links it to the current process in the supervision tree.

Link to this section Types

Link to this type

logger_options_t()

View Source
logger_options_t() :: struct() | nil
Link to this type

message_t()

View Source
message_t() :: [message_t()] | String.t() | {:binary, binary()} | integer()
Link to this type

msg_level_t()

View Source
msg_level_t() :: :warn | :debug | :info
Link to this type

process_options_t()

View Source
process_options_t() :: GenServer.options()

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

shutdown(server, timeout \\ 5000)

View Source
shutdown(pid(), timeout()) :: :ok

Stops given logger process.

It will wait for reply for amount of time passed as second argument (in milliseconds).

Will trigger calling handle_shutdown/2 logger callback.

Returns :ok.

Link to this function

start(module, logger_options \\ nil, process_options \\ [])

View Source

Starts process for logger of given module, initialized with given options outside of the supervision tree.

Works similarly to GenServer.start/3 and has the same return values.

Link to this function

start_link(module, logger_options \\ nil, process_options \\ [])

View Source

Starts process for logger of given module, initialized with given options and links it to the current process in the supervision tree.

Works similarly to GenServer.start_link/3 and has the same return values.