Method: Redis::Commands::Streams#xread

Defined in:

lib/redis/commands/streams.rb

#xread(keys, ids, count: nil, block: nil) ⇒ Hash{String => Hash{String => Hash}}

Fetches entries from one or multiple streams. Optionally blocking.

Examples:

With a key

redis.xread('mystream', '0-0')

With multiple keys

redis.xread(%w[mystream1 mystream2], %w[0-0 0-0])

With count option

redis.xread('mystream', '0-0', count: 2)

With block option

redis.xread('mystream', '$', block: 1000)

Parameters:

• keys (Array<String>) —

  one or multiple stream keys

• ids (Array<String>) —

  one or multiple entry ids

• count (Integer) (defaults to: nil) —

  the number of entries as limit per stream

• block (Integer) (defaults to: nil) —

  the number of milliseconds as blocking timeout

Returns:

• (Hash{String => Hash{String => Hash}}) —

  the entries

# File 'lib/redis/commands/streams.rb', line 193

def xread(keys, ids, count: nil, block: nil)
  args = [:xread]
  args << 'COUNT' << count if count
  args << 'BLOCK' << block.to_i if block
  _xread(args, keys, ids, block)
end