KafkaMessageBus v4.2.3 API Reference

Modules

Set of functions that can be used by the app that depends on the kafka message bus. This serves as an entry point to the app for producers.

This defines behaviors for message bus adapters.

Implements adapter behavior for Exq (a job processing library for Elixir).

Consumer module for Exq.

Contains the process/1 function that will queue up the message for retry.

Implements adapter behavior for Kafka (via Kaffe).

Consumer module for Kaffe (Kafka).

This is an Adapter implementation that can be used in testing contexts instead of Kafka directly.

Application module for KafkaMessageBus. This kicks off the supervisor for the app using the one_for_one strategy (restart failed processes only).

A set of functions that help retrieve config data.

Defines behaviors for kafka message bus consumers. The apps depending on this app will implement these.

Legacy dead letter queue handler.

Contains perform/2 function that is used to consume a message using the specified module.

This is used to show how exclusions work.

This is an example of how validator structs should be written.

A set of functions that takes resource, action, and data as parameters and returns an instance of the appropriate message data struct. Each message data type will support a function new/1 that is a struct representation of the map data that it received. These new/1 functions do not alter or validate the data field values.

Module includes a set of validate functions. These functions take wither the message data in isolation or in the context of the message itself and it returns the validation result.

The MessageData protocol supports the definition of message bodies. Structs that implement MessageData are used in the 'data' field of the CgMessage str ct.

A set of functions that take resource, action, and data as parameters and returns an instance of the appropriate message data struct. Each message data type will support a function new/1 that is a struct representation of the map data that it received. These new/1 functions do not alter or validate the data field values.

A set of map utility functions utilized by the message validation.

This is the base module for all message data type definition. A message data type is the type that represents the contents of the 'data' field on the kafka message.

This is the module that handles unrecognized messages (based on resource and action).

The MessageData Validator module contains functions used to support Ecto schema validation.

This is the module that contains the producer functions. It is used directly by the KafkaMessageBus module.

A set of functions that handles adapters for KafkaMessageBus.Producer. This code was originally extracted from Producer.

A set of utility functions.