ex_waiter v1.3.1

ExWaiter.Polling (ex_waiter v1.3.1) View Source

Link to this section Summary

Types

options()
poll_result()

Functions

new_poller(polling_fn, opts)
poll_once(poller)

Link to this section Types

Link to this type

options()

View Source

Specs

options() :: [
  delay: ExWaiter.Polling.Poller.Config.delay(),
  max_attempts: ExWaiter.Polling.Poller.Config.max_attempts(),
  record_history: boolean()
]
Link to this type

poll_result()

View Source

Specs

poll_result() ::
  {:ok, ExWaiter.Polling.Poller.t()}
  | {:error, :retries_exhausted, ExWaiter.Polling.Poller.t()}
  | {:error, :attempt_failed, ExWaiter.Polling.Poller.t()}

Link to this section Functions

Link to this function

new_poller(polling_fn, opts)

View Source

Specs

new_poller(ExWaiter.Polling.Poller.Config.polling_fn(), options()) ::
  ExWaiter.Polling.Poller.t()
Link to this function

poll_once(poller)

View Source

Specs

poll_once(ExWaiter.Polling.Poller.t()) :: poll_result()