kafka_ex v0.6.2 API Reference

Modules

KafkaEx

Handles compression/decompression of messages

Configuring KafkaEx

Default GenEvent handler for KafkaEx.stream

A collection of common request generation and response parsing functions for the Kafka wire protocol

Implementation of the Kafka ConsumerMetadata request and response APIs

Implementation of the Kafka Fetch request and response APIs

Implementation of the Kafka Hearbeat request and response APIs

Implementation of the Kafka JoinGroup request and response APIs

Implementation of the Kafka Hearbeat request and response APIs

Implementation of the Kafka Offset request and response APIs

Implementation of the Kafka OffsetCommit request and response APIs

Implementation of the Kafka OffsetFetch request and response APIs

Implementation of the Kafka Produce request and response APIs

  • key: is used for partition assignment, can be nil, when none is provided it is defaulted to nil
  • value: is the message to be written to kafka logs
  • require_acks: indicates how many acknowledgements the servers should receive before responding to the request. If it is 0 the server will not send any response (this is the only case where the server will not reply to a request). If it is 1, the server will wait the data is written to the local log before sending a response. If it is -1 the server will block until the message is committed by all in sync replicas before sending a response. For any number > 1 the server will block waiting for this number of acknowledgements to occur (but the server will never wait for more acknowledgements than there are in-sync replicas), default is 0
  • timeout: provides a maximum time in milliseconds the server can await the receipt of the number of acknowledgements in RequiredAcks, default is 100 milliseconds

Implementation of the Kafka SyncGroup request and response APIs

Defines the KafkaEx.Server behavior that all Kafka API servers must implement, this module also provides some common callback functions that are injected into the servers that use it

Implements kafkaEx.Server behaviors for kafka >= 0.8.0 < 0.8.2 API

Implements kafkaEx.Server behaviors for kafka >= 0.8.2 < 0.9.0 API

Implements kafkaEx.Server behaviors for kafka 0.9.0 API

This module handle all socket related operations