io.lettuce.core

Class XReadArgs

java.lang.Object

io.lettuce.core.XReadArgs

All Implemented Interfaces:

CompositeArgument

public class XReadArgs
extends Object
implements CompositeArgument

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) Build command arguments and contribute arguments to CommandArgs.
XReadArgs	claim(Duration timeout) Claim idle pending messages first with a minimum idle time (milliseconds).
XReadArgs	claim(long milliseconds) Claim idle pending messages first with a minimum idle time (milliseconds).
XReadArgs	count(long count) Limit read to count messages.
XReadArgs	maxCount(long maxCount) Limit the cumulative number of returned entries across all streams to maxCount.
XReadArgs	maxSize(long maxSize) Apply a soft cap of maxSize bytes to the cumulative reply size across all streams.
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.

maxCount

public XReadArgs maxCount(long maxCount)

Limit the cumulative number of returned entries across all streams to maxCount. Unlike COUNT, which is a per-stream limit, MAXCOUNT caps the whole command reply. Once the cap is reached, remaining streams are skipped. Defaults to unlimited when not set. When used together with COUNT, maxCount must be greater than or equal to the count.

Parameters:

maxCount - cumulative cap on the number of returned entries across all streams, must be positive.

Returns:

this.

Since:

7.7

maxSize

public XReadArgs maxSize(long maxSize)

Apply a soft cap of maxSize bytes to the cumulative reply size across all streams. The server measures the serialized reply including protocol overhead, so this is not an exact payload-size guarantee: the first available entry is returned even when it alone exceeds the cap, and emission stops before the next entry once the budget is reached. Once the cap is reached, remaining streams are skipped. Defaults to unlimited when not set.

Parameters:

maxSize - soft cumulative cap on the reply size in bytes across all streams, must be positive.

Returns:

this.

Since:

7.7

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.

claim

public XReadArgs claim(long milliseconds)

Claim idle pending messages first with a minimum idle time (milliseconds).

Parameters:

milliseconds - minimum idle time.

Returns:

this.

Since:

7.1

claim

public XReadArgs claim(Duration timeout)

Claim idle pending messages first with a minimum idle time (milliseconds).

Parameters:

timeout - minimum idle time.

Returns:

this.

Since:

7.1

build

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

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.