io.nats.client

Class BaseConsumeOptions

java.lang.Object

io.nats.client.BaseConsumeOptions

All Implemented Interfaces:

JsonSerializable

Direct Known Subclasses:

ConsumeOptions, FetchConsumeOptions

public class BaseConsumeOptions
extends java.lang.Object
implements JsonSerializable

Base Consume Options are provided to customize the way the consume and fetch operate. It is the base class for ConsumeOptions and FetchConsumeOptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseConsumeOptions.Builder<B,CO>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	bytes
static long	DEFAULT_EXPIRES_IN_MILLIS
static int	DEFAULT_MESSAGE_COUNT
static int	DEFAULT_MESSAGE_COUNT_WHEN_BYTES
static int	DEFAULT_THRESHOLD_PERCENT
protected long	expiresIn
protected java.lang.String	group
protected long	idleHeartbeat
static long	MAX_HEARTBEAT_MILLIS
static int	MAX_IDLE_HEARTBEAT_PERCENT
protected int	messages
static long	MIN_EXPIRES_MILLS
protected long	minAckPending
protected long	minPending
protected boolean	raiseStatusWarnings
protected int	thresholdPercent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseConsumeOptions(BaseConsumeOptions.Builder<?,?> b)

Method Summary

Modifier and Type	Method and Description
long	getExpiresInMillis()
java.lang.String	getGroup()
long	getIdleHeartbeat()
long	getMinAckPending()
long	getMinPending()
int	getThresholdPercent()
boolean	raiseStatusWarnings()
protected void	subclassSpecificToJson(java.lang.StringBuilder sb)
java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Field Detail

DEFAULT_MESSAGE_COUNT

public static final int DEFAULT_MESSAGE_COUNT

See Also:

Constant Field Values

DEFAULT_MESSAGE_COUNT_WHEN_BYTES

public static final int DEFAULT_MESSAGE_COUNT_WHEN_BYTES

See Also:

Constant Field Values

DEFAULT_THRESHOLD_PERCENT

public static final int DEFAULT_THRESHOLD_PERCENT

See Also:

Constant Field Values

DEFAULT_EXPIRES_IN_MILLIS

public static final long DEFAULT_EXPIRES_IN_MILLIS

See Also:

Constant Field Values

MIN_EXPIRES_MILLS

public static final long MIN_EXPIRES_MILLS

See Also:

Constant Field Values

MAX_HEARTBEAT_MILLIS

public static final long MAX_HEARTBEAT_MILLIS

See Also:

Constant Field Values

MAX_IDLE_HEARTBEAT_PERCENT

public static final int MAX_IDLE_HEARTBEAT_PERCENT

See Also:

Constant Field Values

messages

protected final int messages

bytes

protected final long bytes

expiresIn

protected final long expiresIn

thresholdPercent

protected final int thresholdPercent

idleHeartbeat

protected final long idleHeartbeat

group

protected final java.lang.String group

minPending

protected final long minPending

minAckPending

protected final long minAckPending

raiseStatusWarnings

protected final boolean raiseStatusWarnings

Constructor Detail

BaseConsumeOptions

protected BaseConsumeOptions(BaseConsumeOptions.Builder<?,?> b)

Method Detail

toJson

public java.lang.String toJson()

Specified by:

toJson in interface JsonSerializable

subclassSpecificToJson

protected void subclassSpecificToJson(java.lang.StringBuilder sb)

getExpiresInMillis

public long getExpiresInMillis()

getIdleHeartbeat

public long getIdleHeartbeat()

getThresholdPercent

public int getThresholdPercent()

raiseStatusWarnings

public boolean raiseStatusWarnings()

getGroup

public java.lang.String getGroup()

getMinPending

public long getMinPending()

getMinAckPending

public long getMinAckPending()