misha_cafex v0.0.5 Cafex.Consumer behaviour

Consumer worker implementation specification.

Callbacks

• init(args)

• consume(message, state)

• terminate(state)

Summary

Types

done()

state()

Callbacks

consume(message, state)

init(args)

terminate(state)

Types

done :: :ok | :nocommit

state :: term

Callbacks

consume(message, state)

Specs

consume(message :: Cafex.Protocol.Message.t, state) ::
  {done, state} |
  {:pause, timeout}

init(args)

Specs

init(args :: term) ::
  {:ok, state} |
  {:error, reason :: term}

terminate(state)

Specs

terminate(state) :: :ok