riemannx v3.1.1 Riemannx.Connections.TLS View Source
TLS is a secure TCP connection, you can use this if communicating with your riemann server securely is important - it carries some overhead and is much slower than UDP/combined but the trade-off is obviously worth it if security is a concern.
Special Notes
- This library was built for my use-case which required speed at the expense of reliability hence why combined is the default. If, however you require guarantees on message order then TCP / TLS is the way to go.
Link to this section Summary
Functions
Callback implementation for Riemannx.Connection.get_worker/1
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Callback implementation for Riemannx.Connection.query/3
Callback implementation for Riemannx.Connection.release/2
Callback implementation for Riemannx.Connection.send/2
Callback implementation for Riemannx.Connection.send_async/2
Link to this section Functions
Callback implementation for Riemannx.Connection.get_worker/1
.
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 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
.
Callback implementation for Riemannx.Connection.query/3
.
Callback implementation for Riemannx.Connection.release/2
.
Callback implementation for Riemannx.Connection.send/2
.
Callback implementation for Riemannx.Connection.send_async/2
.