Summary

Types

hostname()

Shorthand type for socket.

port_number()

Shorthand type for port number.

Given a remote node id, I start a proxy engine that represents that remote node.

I start a new TCP client connection to a given host and port.

I start a new TCP server for the given node.

@type hostname() :: :inet.socket_address() | :inet.hostname()

Shorthand type for socket.

@type port_number() :: :inet.port_number()

Shorthand type for port number.

@spec start_engine_proxy(String.t(), String.t(), atom()) ::
  {:ok, pid()} | {:error, term()}

Given a remote node id, I start a proxy engine that represents that remote node.

@spec start_tcp_client(
  String.t(),
  {hostname(), port_number()}
) :: {:ok, pid(), port_number()} | {:error, term()}

I start a new TCP client connection to a given host and port.

@spec start_tcp_server(
  String.t(),
  {hostname(), port_number()}
) :: {:ok, pid(), port_number()} | {:error, term()}

I start a new TCP server for the given node.