redis.clients.jedis.params

Class XReadGroupParams

java.lang.Object

redis.clients.jedis.params.XReadGroupParams

All Implemented Interfaces:

IParams

public class XReadGroupParams
extends java.lang.Object
implements IParams

Constructor Summary

Constructors

Constructor and Description
XReadGroupParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
XReadGroupParams	block(int block)
XReadGroupParams	claim(long minIdleMillis)
XReadGroupParams	count(int count)
boolean	equals(java.lang.Object o)
int	hashCode()
XReadGroupParams	maxCount(int maxCount) Limit the total number of entries returned across all streams combined.
XReadGroupParams	maxSize(long maxSize) Apply a soft cap to the total server reply size in bytes across all streams combined.
XReadGroupParams	noAck()
static XReadGroupParams	xReadGroupParams()

Methods inherited from class java.lang.Object

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

Constructor Detail

XReadGroupParams

public XReadGroupParams()

Method Detail

xReadGroupParams

public static XReadGroupParams xReadGroupParams()

count

public XReadGroupParams count(int count)

maxCount

public XReadGroupParams maxCount(int maxCount)

Limit the total number of entries returned across all streams combined. Unlike COUNT, which is a per-stream limit, MAXCOUNT caps the whole command reply; once the cap is reached, remaining streams are skipped. Entries not emitted because of the cap are neither delivered nor added to the consumer's pending entries. Defaults to unlimited when unset. Must be a positive integer and, when COUNT is also set and positive, greater than or equal to it (validated by the server).

Parameters:

maxCount - cumulative entry cap across all streams

Returns:

this

Since:

8.0

maxSize

public XReadGroupParams maxSize(long maxSize)

Apply a soft cap to the total server reply size in bytes across all streams combined. The server measures the serialized reply it is building, including protocol overhead, so this is not an exact payload-size guarantee: a single first available entry larger than the cap is still returned, and the reply may be empty if no entries are available. Defaults to unlimited when unset. Must be a positive integer (validated by the server).

Parameters:

maxSize - cumulative soft reply-size cap in bytes

Returns:

this

Since:

8.0

block

public XReadGroupParams block(int block)

noAck

public XReadGroupParams noAck()

claim

public XReadGroupParams claim(long minIdleMillis)

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object