Kayrock.Socket (kayrock v0.1.15) View Source

This module handle all socket related operations.

NOTE this is a copy of KafkaEx.Socket: https://github.com/kafkaex/kafka_ex/blob/master/lib/kafka_ex/socket.ex

It is duplicated here to avoid creating a circular dependency.

Link to this section Summary

Types

t()

Functions

close(socket)

Closes the socket.

create(host, port, socket_options \\ [], is_ssl \\ false)

Creates a socket.

info(socket)

Returns the information about the socket.

open?(socket)

Returns true if the socket is open

recv(socket, length)

Receives data from the socket.

recv(socket, length, timeout)

send(socket, data)

Sends data over the socket.

setopts(socket, options)

Set options to the socket.

Link to this section Types

t()

Specs

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

Link to this section Functions

close(socket)

Specs

close(t()) :: :ok

Closes the socket.

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

create(host, port, socket_options \\ [], is_ssl \\ false)

Creates a socket.

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

info(socket)

Specs

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

Returns the information about the socket.

For more information, see Port.info

open?(socket)

Specs

open?(t()) :: boolean()

Returns true if the socket is open

recv(socket, length)

Specs

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.

recv(socket, length, timeout)

Specs

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

send(socket, data)

Specs

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.

setopts(socket, options)

Specs

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.