View Source BroadwaySQS.SQSClient behaviour (BroadwaySQS v0.7.3)

A generic behaviour to implement SQS Clients for BroadwaySQS.Producer. This module defines callbacks to normalize options and receive message from a SQS queue. Modules that implement this behaviour should be passed as the :sqs_client option from BroadwaySQS.Producer.

Link to this section Summary

Link to this section Types

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

Link to this section Callbacks

@callback init(opts :: any()) ::
  {:ok, normalized_opts :: any()} | {:error, reason :: binary()}
Link to this callback

receive_messages(demand, opts)

View Source
@callback receive_messages(demand :: pos_integer(), opts :: any()) :: messages()