ServiceWatcher v0.1.9 Service.Watcher

Documentation for Service.Watcher.

Link to this section Summary

Link to this section Functions

Link to this function add_service(server \\ __MODULE__, service_name, mode, timeout \\ Application.get_env(:service_watcher_sup, :default_watch_interval, 5000))
Link to this function get_services(server \\ __MODULE__)
Link to this function get_services_def(server \\ __MODULE__)

Hello world.

Examples

iex> Service.Watcher.hello
:world

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

args 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 handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

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 :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 (re)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 pause(server \\ __MODULE__, service_name)
Link to this function pause_all(server \\ __MODULE__)
Link to this function pause_timer_job(service_name)
Link to this function resume(server \\ __MODULE__, service_name)
Link to this function resume_all(server \\ __MODULE__)
Link to this function resume_timer_job(service_name)
Link to this function send_message(message, destination)
Link to this function service_name_alias(service_name)
Link to this function service_to_string(def)
Link to this function start_link(services \\ [], gen_server_options \\ [])
Link to this function start_watching(service_name, mode, watch_interval)
Link to this function stop_timer_job(service_name)
Link to this function stop_watching(server \\ __MODULE__, service_name)
Link to this function update_interval_period(service_name, interval, period \\ nil)
Link to this function update_timer_state(service_name, new_state)
Link to this function watch_service(service_name, mode, expected_state, prev_state, notify_destination, watch_interval \\ 5000, expiration_period \\ :infinity)