off_broadway_kafka v0.3.1 API Reference

Modules

Implements a macro for easily including the OffBroadway.Kafka library in your application and declaring the callbacks expected by the framework to configure it's Broadway and Kafka configurations. The OffBroadway.Kafka process creates an Elsa group supervisor as part of its setup to manage consumer group interaction with the cluster.

Implements the Broadway acknowledger behaviour, handling acking of processed messages back to Kafka once they have been successfully processed. Message ack references are stored in ETS as an ordered set and acknowledgements are performed in the order received rather than the order processed to ensure that a failure of the Broadway pipeline does not allow messages received later but processed faster to erroneously mark lost messages as acknowledged when they should instead be reprocessed on recovery of the pipeline.

Supplies a message handler for integrating with Broadway in a more traditional manner of including Broadway directly in the implementing application only supplying a handler module customized to the producing system. The "Classic" handler supplies a simple pass-through init function and delegates message handling to the OffBroadway.Kafka.Producer module.

Implements the logic to handle incoming messages through the broadway pipeline. Sends messages to the handle_info/2 and handle_demand/2 functions based on requests and tracks acknowledgements in state.

Implements message handling using an opinionated interpretation of Broadway for interaction with Kafka. Intended for use in conjunction with the __using__ macro provided by OffBroadway.Kafka. Assumes a single producer stage, preconfigured to use the OffBroadway.Kafka.Producer module and takes configuration for additional Broadway elements via the Elsa configurations passed through via the kafka_config/1 function and those passed to Broadway via the broadway_config/1 functions defined in the top-level module's behaviour callbacks.