simplestatex v0.3.0 SimpleStatEx.Server.SimpleStatSet

A service that holds statistic counters mapped by time period in memory.

Link to this section Summary

Functions

Add a statistic to the state

Returns a specification to start this module under a supervisor

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Select stats from state based on query parameters

Reset the stat bucket

Start with a name that was generated by simple stat protocol

Link to this section Functions

Link to this function add_stat(category_bucket, simple_stat)

Add a statistic to the state

Link to this function child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function get_stats!(category_bucket)
Link to this function get_stats(category_bucket, period \\ :all)
Link to this function handle_call(arg, category_state)

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

init_arg is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state}, except that it also sets a timeout. See the “Timeouts” section in the module documentation for more information.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function query_stats!(category_bucket, simple_stat, simple_stat_query)
Link to this function query_stats(category_bucket, simple_stat, simple_stat_query)

Select stats from state based on query parameters

Link to this function reset(category_bucket)

Reset the stat bucket

Link to this function start_link(name)

Start with a name that was generated by simple stat protocol