KafkaEx.Socket (kafka_ex v0.12.1) View Source

This module handle all socket related operations.

Link to this section Summary

Functions

Closes the socket.

Returns the information about the socket.

Returns true if the socket is open

Receives data from the socket.

Sends data over the socket.

Set options to the socket.

Link to this section Types

Specs

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

Link to this section Functions

Specs

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.

Specs

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

Returns the information about the socket.

For more information, see Port.info

Specs

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

Returns true if the socket is open

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.

Link to this function

recv(socket, length, timeout)

View Source

Specs

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

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.

Link to this function

setopts(socket, options)

View Source

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.