Specs

api_response() :: map()

Represents an API response message

This will generally be a generated struct.

Specs

api_version() :: non_neg_integer()

Specifies the version of an API message

Kayrock will generally try to pick a reasonable default here, but you can override it in many cases. See Kafka Protocol Documentation

Specs

broker_pid() :: pid()

A pid for a Kayrock.BrokerConnection process.

This is for low-level communication with individual brokers. Generally you should work with a client_pid.

Specs

client_pid() :: pid()

A pid for a Kayrock.Client process.

Specs

node_id() :: integer()

A broker's advertised integer node id

Specs

node_selector() ::
  node_id()
  | :random
  | :controller
  | {:topic_partition, topic_name(), partition_id()}

A node selector for sending messages to the cluster

Generally the Kayrock API will select the right node depending on the operation. These are exposed to provide fine-grained user control in a few cases where it might make sense to override the default.

Possible values:

• Integer - Directly access a node by id. Generally you should not do this unless you are operating at a low level.
• :random - Select a node at random from the cluster metadata.
• :controller - Select the controller node - this is used for cluster management messages

Specs

partition_id() :: non_neg_integer()

Specs

topic_name() :: binary()