SwimEx.Transport behaviour (SwimEx v0.1.0)

Behaviour for SWIM transport implementations.

Implementations must deliver received packets to the registered receiver as {:swim_packet, from :: {String.t(), port}, binary}.

Summary

node_id()

server()

close(server)

Close the transport.

Send a binary payload to the given node.

Start the transport, binding to the given port.

Strips the cookie from a 3-element identity tuple, returning a 2-element transport address.

@type node_id() :: {String.t(), :inet.port_number()}

@type server() :: GenServer.server()

@callback close(server()) :: :ok

Close the transport.

@callback send(server(), node_id(), binary()) :: :ok | {:error, term()}

Send a binary payload to the given node.

@callback set_receiver(server(), pid()) :: :ok

@callback start_link(keyword()) :: GenServer.on_start()

Start the transport, binding to the given port.

@spec strip_cookie({String.t(), :inet.port_number(), String.t()} | node_id()) ::
  node_id()

Strips the cookie from a 3-element identity tuple, returning a 2-element transport address.