View Source OffBroadwayRedisStream.RedisClient behaviour (off_broadway_redis_stream v0.4.0)

Link to this section Summary

Link to this section Types

@type id() :: String.t()
@type message() :: [any()]

Link to this section Callbacks

@callback ack(ids :: [id()], config :: keyword()) ::
  :ok
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
Link to this callback

claim(idle, ids, config)

View Source
@callback claim(idle :: pos_integer(), ids :: [id()], config :: keyword()) ::
  {:ok, messages :: [message()]}
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
@callback consumers_info(config :: keyword()) ::
  {:ok, any()}
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
Link to this callback

create_group(offset, config)

View Source
@callback create_group(offset :: String.t(), config :: keyword()) ::
  :ok
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
Link to this callback

delete_consumers(consumers, config)

View Source
@callback delete_consumers(consumers :: [String.t()], config :: keyword()) ::
  :ok
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
Link to this callback

delete_message(ids, config)

View Source
@callback delete_message(ids :: [id()], config :: keyword()) ::
  :ok
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
Link to this callback

fetch(demand, last_id, config)

View Source
@callback fetch(demand :: pos_integer(), last_id :: id(), config :: keyword()) ::
  {:ok, messages :: [message()]}
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}
@callback init(config :: keyword()) :: {:ok, any()} | {:error, any()}
Link to this callback

pending(consumer, count, config)

View Source
@callback pending(consumer :: String.t(), count :: pos_integer(), config :: keyword()) ::
  {:ok, any()}
  | {:error, OffBroadwayRedisStream.RedisClient.ConnectionError.t()}
  | {:error, any()}