tortoise311 v0.11.1

Tortoise311.Transport behaviour (tortoise311 v0.11.1) View Source

Abstraction for working with network connections; this is done to normalize the :ssl and :gen_tcp modules, so they get a similar interface.

This work has been heavily inspired by the Ranch project by NineNines.

Link to this section Summary

Types

opts()
socket()
stats()
t()

Callbacks

accept(socket, timeout)
accept_ack(socket, timeout)
close(socket)
connect(charlist, port_number, opts, timeout)
controlling_process(socket, pid)
getopts(socket, list)
getstat(socket)
getstat(socket, list)
listen(opts)
new(opts)
peername(socket)
recv(socket, non_neg_integer, timeout)
send(socket, iodata)
setopts(socket, opts)
shutdown(socket, arg2)
sockname(socket)

Functions

new(arg)

Create a new Transport specification used by the Connection process to log on to the MQTT server. This allow us to filter the options passed to the connection type, and guide the user to connect to the individual transport type.

Link to this section Types

Link to this type

opts()

View Source

Specs

opts() :: any()
Link to this type

socket()

View Source

Specs

socket() :: any()
Link to this type

stats()

View Source

Specs

stats() :: any()
Link to this opaque

t()

View Source (opaque)

Specs

t()

Link to this section Callbacks

Link to this callback

accept(socket, timeout)

View Source

Specs

accept(socket(), timeout()) ::
  {:ok, socket()} | {:error, :closed | :timeout | atom()}
Link to this callback

accept_ack(socket, timeout)

View Source

Specs

accept_ack(socket(), timeout()) :: :ok
Link to this callback

close(socket)

View Source

Specs

close(socket()) :: :ok
Link to this callback

connect(charlist, port_number, opts, timeout)

View Source

Specs

connect(charlist(), :inet.port_number(), opts(), timeout()) ::
  {:ok, socket()} | {:error, atom()}
Link to this callback

controlling_process(socket, pid)

View Source

Specs

controlling_process(socket(), pid()) ::
  :ok | {:error, :closed | :now_owner | atom()}
Link to this callback

getopts(socket, list)

View Source

Specs

getopts(socket(), [atom()]) :: {:ok, opts()} | {:error, atom()}
Link to this callback

getstat(socket)

View Source

Specs

getstat(socket()) :: {:ok, stats()} | {:error, atom()}
Link to this callback

getstat(socket, list)

View Source

Specs

getstat(socket(), [atom()]) :: {:ok, stats()} | {:error, atom()}
Link to this callback

listen(opts)

View Source

Specs

listen(opts()) :: {:ok, socket()} | {:error, atom()}
Link to this callback

new(opts)

View Source

Specs

new(opts()) :: t()
Link to this callback

peername(socket)

View Source

Specs

peername(socket()) ::
  {:ok, {:inet.ip_address(), :inet.port_number()}} | {:error, atom()}
Link to this callback

recv(socket, non_neg_integer, timeout)

View Source

Specs

recv(socket(), non_neg_integer(), timeout()) ::
  {:ok, any()} | {:error, :closed | :timeout | atom()}
Link to this callback

send(socket, iodata)

View Source

Specs

send(socket(), iodata()) :: :ok | {:error, atom()}
Link to this callback

setopts(socket, opts)

View Source

Specs

setopts(socket(), opts()) :: :ok | {:error, atom()}
Link to this callback

shutdown(socket, arg2)

View Source

Specs

shutdown(socket(), :read | :write | :read_write) :: :ok | {:error, atom()}
Link to this callback

sockname(socket)

View Source

Specs

sockname(socket()) ::
  {:ok, {:inet.ip_address(), :inet.port_number()}} | {:error, atom()}

Link to this section Functions

Link to this function

new(arg)

View Source

Specs

new({atom(), [term()]}) :: t()

Create a new Transport specification used by the Connection process to log on to the MQTT server. This allow us to filter the options passed to the connection type, and guide the user to connect to the individual transport type.