effusion v0.1.0 Effusion.BTP.SessionServer View Source

An API to manage a Effusion.BTP.Session object as it is connected to many peers simultaneously.

Link to this section Summary

Functions

Wait on a download managed by a session server to complete

Handle a Peer Wire Protocol (PWP) message sent by a remote peer

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

Start the Session Server in its own supervision tree

Start the session server and link it to the current process

Link to this section Functions

Wait on a download managed by a session server to complete.

Link to this function handle_message(pid, peer_id, message) View Source

Handle a Peer Wire Protocol (PWP) message sent by a remote peer.

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 start(meta, local_server, file) View Source

Start the Session Server in its own supervision tree.

Start the session server and link it to the current process.

Link to this function unregister_connection(pid, peer_id, address \\ nil) View Source

Handle a peer disconnection.