kafka_ex v0.13.0

View Source KafkaEx.Socket (kafka_ex v0.13.0)

This module handle all socket related operations.

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

Link to this type

t()

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

Link to this section Functions

Link to this function

close(socket)

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

Closes the socket.

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

Link to this function

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

View Source

Creates a socket.

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

Link to this function

info(socket)

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

Returns the information about the socket.

For more information, see Port.info

Link to this function

open?(socket)

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

Returns true if the socket is open

Link to this function

recv(socket, length)

View Source 
@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.

Link to this function

recv(socket, length, timeout)

View Source 
@spec recv(t(), non_neg_integer(), timeout()) ::
  {:ok, String.t() | binary() | term()} | {:error, any()}
Link to this function

send(socket, data)

View Source 
@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.

Link to this function

setopts(socket, options)

View Source 
@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.