KafkaBatcher.Behaviours.Collector behaviour (kafka_batcher v1.1.1)

Collector must implement add_events/1 callback to receive events.

Event could be a MessageObject or a tuple with headers, key and value, but headers and key could be omitted

Summary

event()

events()

header_key()

header_value()

headers()

key()

message_object()

value()

@type event() ::
  {headers(), key(), value()} | {key(), value()} | value() | message_object()

@type events() :: [event()]

@type header_key() :: binary()

@type header_value() :: binary()

@type headers() :: [{header_key(), header_value()}]

@type key() :: binary() | nil

@type message_object() :: KafkaBatcher.MessageObject.t()

@type value() :: map() | binary()

@callback add_events(events :: events()) :: :ok | {:error, term()}