brodex v0.0.2 Brodex.GroupSubscriber behaviour View Source

Wrapper of :brod_group_subscriber.

Link to this section Summary

Types

callback_spec()

A spec for callback.

callback_state()

:brod_group_subscriber.cb_state

start_link_option()

Functions

start_link(client, group_id, topics, callback_spec, options)

Wrapper of :brod_group_subscriber.start_link/8.

stop(pid)

Wrapper of :brod_group_subscriber.stop/1.

Callbacks

handle_message(topic, partition, message_or_message_set, callback_state)

init(group_id, term)

Link to this section Types

callback_spec()

callback_spec() :: module() | {module(), any()}

A spec for callback.

module must implement Brodex.GroupSubscriber behaviour.

callback_state()

callback_state() :: term()

:brod_group_subscriber.cb_state

start_link_option()

start_link_option() ::
  {:group_config, Brodex.group_config()}
  | {:consumer_config, Brodex.consumer_config()}
  | {:message_type, :message | :message_set}

Link to this section Functions

start_link(client, group_id, topics, callback_spec, options)

start_link(
  Brodex.client(),
  Brodex.group_id(),
  [Brodex.topic()],
  callback_spec(),
  [start_link_option()]
) :: {:ok, pid()} | {:error, term()}

Wrapper of :brod_group_subscriber.start_link/8.

stop(pid)

stop(pid()) :: :ok

Wrapper of :brod_group_subscriber.stop/1.

Link to this section Callbacks

handle_message(topic, partition, message_or_message_set, callback_state)

handle_message(
  topic :: Brodex.topic(),
  partition :: Brodex.partition(),
  message_or_message_set ::
    Brodex.Message.record() | Brodex.MessageSet.record(),
  callback_state :: callback_state()
) ::
  {:ok, callback_state()}
  | {:ok, :ack, callback_state()}
  | {:ok, :ack_no_commit, callback_state()}

init(group_id, term)

init(group_id :: Brodex.group_id(), term()) :: {:ok, callback_state()}