Compound v0.2.0 Compound.TCP.Connection View Source
GenServer
representing a single TCP connection.
Compound.TCP.Connection
is used as a module for maintaining the Compound.TCP.Connection
state struct and
provides the GenServer
implementation for it.
A Compound.TCP.Connection
consists of a socket and a callback and behaves the following way:
Whenever a new packet via the TCP-socket arrives it sends a new message ({:new_packet, packet, self()}
) to the callback pid
.
setting the callback
The callback can be easily changed by sending a cast {:set_callback, new_pid}
to a running Compound.TCP.Connection
.
State fields
socket
- The socket this connection is receiving and sending packets to.callback
- The pid newly arrived packets are forwarded to.
Link to this section Summary
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
Link to this section Types
t() :: %Compound.TCP.Connection{callback: pid(), socket: :gen_tcp.socket()}
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 :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
.