View Source ThousandIsland.Socket (Thousand Island v1.3.5)

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

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

getopts(socket, options)

Gets the given flags on the socket

getstat(socket)

Returns statistics about the connection.

handshake(socket)

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

negotiated_protocol(socket)

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

peercert(socket)

Returns information in the form of t:public_key.der_encoded() about the peer certificate of the socket.

peername(socket)

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

recv(socket, length \\ 0, timeout \\ nil)

Returns available bytes on the given socket. Up to length 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.

sockname(socket)

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

telemetry_span(socket)

Returns the telemetry span representing the lifetime of this socket

upgrade(socket, module, opts)

Upgrades the transport of the socket to use the specified transport module, performing any client handshaking that may be required. The passed options are blindly passed through to the new transport module.

Types

t()

@type t() :: %ThousandIsland.Socket{
  read_timeout: timeout(),
  silent_terminate_on_error: boolean(),
  socket: ThousandIsland.Transport.socket(),
  span: ThousandIsland.Telemetry.t(),
  transport_module: module()
}

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

Functions

close(socket)

@spec close(t()) :: ThousandIsland.Transport.on_close()

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

getopts(socket, options)

@spec getopts(t(), ThousandIsland.Transport.socket_get_options()) ::
  ThousandIsland.Transport.on_getopts()

Gets the given flags on the socket

Errors are usually from :inet.posix(), however, SSL module defines return type as any()

getstat(socket)

@spec getstat(t()) :: ThousandIsland.Transport.socket_stats()

Returns statistics about the connection.

handshake(socket)

@spec handshake(t()) :: ThousandIsland.Transport.on_handshake()

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

This is normally called internally by ThousandIsland.Handler and does not need to be called by implementations which are based on ThousandIsland.Handler

negotiated_protocol(socket)

@spec negotiated_protocol(t()) :: ThousandIsland.Transport.on_negotiated_protocol()

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

peercert(socket)

@spec peercert(t()) :: ThousandIsland.Transport.on_peercert()

Returns information in the form of t:public_key.der_encoded() about the peer certificate of the socket.

peername(socket)

@spec peername(t()) :: ThousandIsland.Transport.on_peername()

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

recv(socket, length \\ 0, timeout \\ nil)

@spec recv(t(), non_neg_integer(), timeout() | nil) ::
  ThousandIsland.Transport.on_recv()

Returns available bytes on the given socket. Up to length 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)

@spec secure?(t()) :: boolean()

Returns whether or not this protocol is secure.

send(socket, data)

@spec send(t(), iodata()) :: ThousandIsland.Transport.on_send()

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

sendfile(socket, filename, offset, length)

@spec sendfile(t(), String.t(), non_neg_integer(), non_neg_integer()) ::
  ThousandIsland.Transport.on_sendfile()

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

setopts(socket, options)

@spec setopts(t(), ThousandIsland.Transport.socket_set_options()) ::
  ThousandIsland.Transport.on_setopts()

Sets the given flags on the socket

Errors are usually from :inet.posix(), however, SSL module defines return type as any()

shutdown(socket, way)

@spec shutdown(t(), ThousandIsland.Transport.way()) ::
  ThousandIsland.Transport.on_shutdown()

Shuts down the socket in the given direction.

sockname(socket)

@spec sockname(t()) :: ThousandIsland.Transport.on_sockname()

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

telemetry_span(socket)

@spec telemetry_span(t()) :: ThousandIsland.Telemetry.t()

Returns the telemetry span representing the lifetime of this socket

upgrade(socket, module, opts)

@spec upgrade(t(), module(), term()) :: ThousandIsland.Transport.on_upgrade()

Upgrades the transport of the socket to use the specified transport module, performing any client handshaking that may be required. The passed options are blindly passed through to the new transport module.

This is normally called internally by ThousandIsland.Handler and does not need to be called by implementations which are based on ThousandIsland.Handler