ZenMonitor v1.0.0 ZenMonitor.Proxy View Source
ZenMonitor.Proxy monitors local processes and proxies their down messages to interested ZenMonitor.Locals on remote nodes for fanout.
Link to this section Summary
Types
An instruction is a valid operation upon a given destination
Defines the valid operations that can be processed
A string of instructions with the same operation can be collapsed into a partition for more efficient processing
Functions
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
Ping is a diagnostic function to check that the proxy is running
Link to this section Types
instruction() :: {operation(), ZenMonitor.destination()}
An instruction is a valid operation upon a given destination
Defines the valid operations that can be processed
A string of instructions with the same operation can be collapsed into a partition for more efficient processing.
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
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 {: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 callingSupervisor.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
.
Ping is a diagnostic function to check that the proxy is running.
It is mainly used by ZenMonitor.Local.Connectors to check if ZenMonitor.Proxy is available and running on a remote node