View Source OffBroadway.Splunk.Client behaviour (off_broadway_splunk v1.2.0)

A generic behaviour for implementing Splunk clients for OffBroadway.Splunk.Producer.

This module defines callbacks to normalize options and receive items for a Splunk SID (Search ID).

Modules that implements this behaviour should be passed as the :splunk_client option from OffBroadway.Splunk.Producer.

Link to this section Summary

Link to this section Types

@type messages() :: [Broadway.Message.t()]

Link to this section Callbacks

Link to this callback

ack_message(message, ack_options)

View Source (optional)
@callback ack_message(message :: Broadway.Message.t(), ack_options :: any()) :: any()
@callback init(opts :: any()) ::
  {:ok, normalized_opts :: any()} | {:error, reason :: binary()}
Link to this callback

receive_messages(sid, demand, opts)

View Source
@callback receive_messages(sid :: binary(), demand :: pos_integer(), opts :: any()) ::
  messages()
Link to this callback

receive_status(sid, opts)

View Source
@callback receive_status(sid :: binary(), opts :: any()) ::
  {:ok, response :: any()} | {:error, reason :: any()}