package kafka-eio

  1. Overview
  2. Docs

kafka-eio

API

Library kafka-eio.consumer

Library kafka-eio.core

  • Kafka_consumer_handle Opaque consumer handle type shared between kafka-eio-core and kafka-eio-producer. This exists solely so kafka-eio-producer can accept a consumer handle in with_transaction without directly depending on kafka-eio-consumer.
  • Kafka_error OCaml mirror of librdkafka's rd_kafka_resp_err_t. Internal (negative) error codes and Kafka protocol (positive) error codes are both represented. The full variant list is autogenerated by scripts/gen_errors.sh.
  • Kafka_raw Unsafe FFI bindings to librdkafka. Internal to kafka-eio-core. Users interact with Kafka_producer and Kafka_consumer, not this module.
  • Kafka_security Security transport configuration shared by producer and consumer.

Library kafka-eio.kafka

  • Kafka Kafka is the canonical entry point: open Kafka and use Kafka.Producer/Kafka.Consumer/Kafka.Error/Kafka.Security instead of the flat Kafka_producer/Kafka_consumer/Kafka_error/ Kafka_security module names those packages still export directly (kept for existing callers — this is a pure alias, not a rename). Kafka_raw is deliberately not aliased here: it is internal to kafka-eio-core and was never meant to be part of the public surface.

Library kafka-eio.producer