redix_stream

v0.2.3

redix_stream v0.2.3 Redix.Stream.Consumer

A Server which handle a single connection to a redix stream.

Link to this section Summary

Types

consumer_name()
group_name()
state()

Functions

ack(consumer, id)
child_spec(arg)

Returns child specification when used with a supervisor

handle_call(arg, from, state)
handle_info(arg, state)

Handles a new message from a stream, dispatching it to the given handler

init(arg)

Initializes a new Redix.Stream.Consumer, establishing a long-term stream with the given redis server

start_link(redix, stream, handler, opts \\ [])

Starts a new GenServer of Redix.Stream.Consumer

terminate(reason, state)

Link to this section Types

Link to this type consumer_name() 
consumer_name() :: String.t()
Link to this type group_name() 
group_name() :: String.t()
Link to this type state() 
state() :: %{
  redix: Redix.Stream.redix(),
  stream: Redix.Stream.t(),
  group_name: group_name(),
  consumer_name: consumer_name(),
  handler: function() | Redix.Stream.handler(),
  process_pending: boolean(),
  raise_errors: boolean()
}

Link to this section Functions

Link to this function ack(consumer, id)
Link to this function child_spec(arg) 
child_spec(
  {Redix.Stream.redix(), Redix.Stream.t(), function() | Redix.Stream.handler(),
   keyword()}
) :: Supervisor.child_spec()

Returns child specification when used with a supervisor.

Link to this function handle_call(arg, from, state)
Link to this function handle_info(arg, state)

Handles a new message from a stream, dispatching it to the given handler.

Link to this function init(arg) 
init(
  {Redix.Stream.redix(), Redix.Stream.t(), function() | Redix.Stream.handler(),
   keyword()}
) :: {:ok, state()}

Initializes a new Redix.Stream.Consumer, establishing a long-term stream with the given redis server.

Link to this function start_link(redix, stream, handler, opts \\ []) 
start_link(
  Redix.Stream.redix(),
  Redix.Stream.t(),
  function() | Redix.Stream.handler(),
  keyword()
) :: GenServer.on_start()

Starts a new GenServer of Redix.Stream.Consumer.

Link to this function terminate(reason, state)