io.lettuce.core

Class XReadArgs

java.lang.Object

io.lettuce.core.XReadArgs

public class XReadArgs
extends Object

Argument list builder for the Redis XREAD and XREADGROUP commands. Static import the methods from XReadArgs.Builder and call the methods: block(…) .

XReadArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

5.1

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XReadArgs.Builder Builder entry points for XReadArgs.
static class	XReadArgs.StreamOffset<K> Value object representing a Stream with its offset.

Constructor Summary

Constructors

Constructor and Description
XReadArgs()

Method Summary

Modifier and Type	Method and Description
XReadArgs	block(Duration timeout) Perform a blocking read and wait up to a timeout for a new stream message.
XReadArgs	block(long milliseconds) Perform a blocking read and wait up to milliseconds for a new stream message.
<K,V> void	build(CommandArgs<K,V> args)
XReadArgs	count(long count) Limit read to count messages.
XReadArgs	noack(boolean noack) Use NOACK option to disable auto-acknowledgement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XReadArgs

public XReadArgs()

Method Detail

block

public XReadArgs block(long milliseconds)

Perform a blocking read and wait up to milliseconds for a new stream message.

Parameters:

milliseconds - max time to wait.

Returns:

this.

block

public XReadArgs block(Duration timeout)

Perform a blocking read and wait up to a timeout for a new stream message.

Parameters:

timeout - max time to wait.

Returns:

this.

count

public XReadArgs count(long count)

Limit read to count messages.

Parameters:

count - number of messages.

Returns:

this.

noack

public XReadArgs noack(boolean noack)

Use NOACK option to disable auto-acknowledgement. Only valid for XREADGROUP.

Parameters:

noack - true to disable auto-ack.

Returns:

this.

build

public <K,V> void build(CommandArgs<K,V> args)