Grains v0.2.0 Grains.DebugTimer

Debug version of Grains.Timer.

To replace the normal Timer with this, start you bread like this:

default_grains = Map.merge(Grains.default_grains, %{periodic: Grains.DebugTimer})
{:ok, bread} = Grains.Supervisor.start_link(recipe, grains, default_grains)

server = Grains.get_name(bread, State)
debug_timer = Grains.get_name(bread, State.Sampler.Timer)
send(debug_timer, :tick)

With Timestamps

Similarly to Grains.Timer, the debug timer accepts an option with_timestamps. If set to true, the :tick must include a timestamp, which is then used when forwarding the received message downstream. If with_timestamps is not set, the :tick must not include a timestamp, and the message is forwarded as-is.

Link to this section Summary

Link to this section Functions

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

handle_push(msg, from, 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

name(left, grain)

See Grains.Timer.name/2.

Link to this function

own_full_name()

See Grains.GenGrain.own_full_name/0.

See Grains.GenGrain.own_name/0.

See Grains.GenGrain.pull/0.

See Grains.GenGrain.pull/1.

See Grains.GenGrain.push/1.

Link to this function

push(short_name, msg)

See Grains.GenGrain.push/2.