KafkaBatcher.Behaviours.Collector behaviour (kafka_batcher v1.0.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

Types

@type event() ::
  {headers(), key(), value()} | {key(), value()} | value() | message_object()
@type events() :: [event()]
Link to this type

header_key()

@type header_key() :: binary()
Link to this type

header_value()

@type header_value() :: binary()
@type headers() :: [{header_key(), header_value()}]
@type key() :: binary() | nil
Link to this type

message_object()

@type message_object() :: KafkaBatcher.MessageObject.t()
@type value() :: map() | binary()

Callbacks

Link to this callback

add_events(events)

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