erps

v0.3.4

erps v0.3.4 Erps.Transport.Tcp View Source

implements a tcp transport strategy.

Link to this section Summary

Types

socket()

Functions

accept(sock, timeout)

Callback implementation for Erps.Transport.Api.accept/2.

connect(host, port, opts)

Callback implementation for Erps.Transport.Api.connect/3.

handshake(socket, opts)

upgrades the socket to active: true. Does not request the client-side for an upgrade to an authenticated or encrypted channel.

listen(port, opts)

Callback implementation for Erps.Transport.Api.listen/2.

recv(sock, length)

Callback implementation for Erps.Transport.Api.recv/2, via :gen_tcp.recv/2.

recv(sock, length, timeout)

Callback implementation for Erps.Transport.Api.recv/3, via :gen_tcp.recv/3.

send(sock, content)

Callback implementation for Erps.Transport.Api.send/2, via :gen_tcp.send/2

upgrade(socket, opts)

upgrades the socket to active: true. Does not upgrade to an authenticated or encrypted channel.

Link to this section Types

Link to this type

socket() View Source 
socket() :: Erps.Transport.Api.socket()

Link to this section Functions

Link to this function

accept(sock, timeout) View Source 
accept(socket(), timeout()) :: {:ok, socket()} | {:error, term()}

Callback implementation for Erps.Transport.Api.accept/2.

Link to this function

connect(host, port, opts) View Source 
connect(term(), :inet.port_number(), keyword()) ::
  {:ok, socket()} | {:error, term()}

Callback implementation for Erps.Transport.Api.connect/3.

Link to this function

handshake(socket, opts) View Source 
handshake(:inet.socket(), keyword()) :: {:ok, Erps.Transport.Api.socket()}

upgrades the socket to active: true. Does not request the client-side for an upgrade to an authenticated or encrypted channel.

Callback implementation for Erps.Transport.Api.handshake/2.

Link to this function

listen(port, opts) View Source 
listen(:inet.port_number(), keyword()) :: {:ok, socket()} | {:error, term()}

Callback implementation for Erps.Transport.Api.listen/2.

Link to this function

recv(sock, length) View Source 
recv(socket(), non_neg_integer()) :: {:ok, binary()} | {:error, term()}

Callback implementation for Erps.Transport.Api.recv/2, via :gen_tcp.recv/2.

Link to this function

recv(sock, length, timeout) View Source 
recv(socket(), non_neg_integer(), timeout()) ::
  {:ok, binary()} | {:error, term()}

Callback implementation for Erps.Transport.Api.recv/3, via :gen_tcp.recv/3.

Link to this function

send(sock, content) View Source 
send(socket(), iodata()) :: :ok | {:error, term()}

Callback implementation for Erps.Transport.Api.send/2, via :gen_tcp.send/2

Link to this function

upgrade(socket, opts) View Source 
upgrade(socket(), keyword()) :: {:ok, :inet.socket()} | {:error, term()}

upgrades the socket to active: true. Does not upgrade to an authenticated or encrypted channel.

Callback implementation for Erps.Transport.Api.upgrade/2.