Kayrock.Socket (kayrock v1.0.1)

This module handle all socket related operations.

It is duplicated here to avoid creating a circular dependency.

Summary

t()

close(socket)

Closes the socket.

Creates a socket.

info(socket)

Returns the information about the socket.

open?(socket)

Returns true if the socket is open

Receives data from the socket.

Sends data over the socket.

Set options to the socket.

@type t() :: %Kayrock.Socket{
  socket: :gen_tcp.socket() | :ssl.sslsocket(),
  ssl: boolean()
}

@spec close(t()) :: :ok

Closes the socket.

For more information, see :ssl.close/1 for ssl or :gen_tcp.send/1 for non ssl.

Creates a socket.

For more information about the available options, see :ssl.connect/3 for ssl or :gen_tcp.connect/3 for non ssl.

@spec info(t()) :: list() | nil

Returns the information about the socket.

For more information, see Port.info

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

Returns true if the socket is open

@spec recv(t(), non_neg_integer()) ::
  {:ok, String.t() | binary() | term()} | {:error, any()}

Receives data from the socket.

For more information, see :ssl.recv/2 for ssl or :gen_tcp.recv/2 for non ssl.

@spec recv(t(), non_neg_integer(), timeout()) ::
  {:ok, String.t() | binary() | term()} | {:error, any()}

@spec send(t(), iodata()) :: :ok | {:error, any()}

Sends data over the socket.

It handles both, SSL and non SSL sockets.

For more information, see :ssl.send/2 for ssl or :gen_tcp.send/2 for non ssl.

@spec setopts(t(), list()) :: :ok | {:error, any()}

Set options to the socket.

For more information, see :ssl.setopts/2 for ssl or :inet.setopts/2 for non ssl.