ThousandIsland.Socket (Thousand Island v0.4.6) View Source

Encapsulates a client connection's underlying socket, providing a facility to read, write, and otherwise manipulate a connection from a client.

Link to this section Summary

Types

t()

A reference to a socket along with metadata describing how to use it

Functions

close(socket)

Closes the given socket. Note that a socket is automatically closed when the handler process which owns it terminates

handshake(socket)

Handshakes the underlying socket if it is required (as in the case of SSL sockets, for example).

local_info(socket)

Returns information in the form of t:ThousandIsland.Transport.socket_info() about the local end of the socket.

negotiated_protocol(socket)

Returns information about the protocol negotiated during transport handshaking (if any).

peer_info(socket)

Returns information in the form of t:ThousandIsland.Transport.socket_info() about the remote end of the socket.

recv(socket, length \\ 0, timeout \\ :infinity)

Returns available bytes on the given socket. Up to num_bytes bytes will be returned (0 can be passed in to get the next 'available' bytes, typically the next packet). If insufficient bytes are available, the function can wait timeout milliseconds for data to arrive.

secure?(socket)

Returns whether or not this protocol is secure.

send(socket, data)

Sends the given data (specified as a binary or an IO list) on the given socket.

sendfile(socket, filename, offset, length)

Sends the contents of the given file based on the provided offset & length

setopts(socket, options)

Sets the given flags on the socket

shutdown(socket, way)

Shuts down the socket in the given direction.

Link to this section Types

t()

Specs

t() :: %ThousandIsland.Socket{
  acceptor_id: String.t(),
  connection_id: String.t(),
  socket: ThousandIsland.Transport.socket(),
  transport_module: module()
}

A reference to a socket along with metadata describing how to use it

Link to this section Functions

close(socket)

Specs

close(t()) :: :ok

Closes the given socket. Note that a socket is automatically closed when the handler process which owns it terminates

handshake(socket)

Specs

handshake(t()) :: {:ok, t()} | {:error, String.t()}

Handshakes the underlying socket if it is required (as in the case of SSL sockets, for example).

local_info(socket)

Specs

local_info(t()) :: ThousandIsland.Transport.socket_info()

Returns information in the form of t:ThousandIsland.Transport.socket_info() about the local end of the socket.

negotiated_protocol(socket)

Specs

negotiated_protocol(t()) :: ThousandIsland.Transport.negotiated_protocol_info()

Returns information about the protocol negotiated during transport handshaking (if any).

peer_info(socket)

Specs

peer_info(t()) :: ThousandIsland.Transport.socket_info()

Returns information in the form of t:ThousandIsland.Transport.socket_info() about the remote end of the socket.

recv(socket, length \\ 0, timeout \\ :infinity)

Specs

recv(t(), non_neg_integer(), timeout()) :: ThousandIsland.Transport.on_recv()

secure?(socket)

Specs

secure?(t()) :: boolean()

Returns whether or not this protocol is secure.

send(socket, data)

Specs

send(t(), IO.chardata()) :: :ok | {:error, term()}

Sends the given data (specified as a binary or an IO list) on the given socket.

sendfile(socket, filename, offset, length)

Specs

sendfile(t(), String.t(), non_neg_integer(), non_neg_integer()) ::
  {:ok, non_neg_integer()} | {:error, String.t()}

Sends the contents of the given file based on the provided offset & length

setopts(socket, options)

Specs

setopts(t(), ThousandIsland.Transport.socket_options()) ::
  :ok | {:error, String.t()}

Sets the given flags on the socket

shutdown(socket, way)

Specs

shutdown(t(), ThousandIsland.Transport.way()) :: :ok

Shuts down the socket in the given direction.