io.nats.client

Class SubscribeOptions

java.lang.Object

io.nats.client.SubscribeOptions

Direct Known Subclasses:

PullSubscribeOptions, PushSubscribeOptions

public abstract class SubscribeOptions
extends java.lang.Object

The SubscribeOptions is the base class for PushSubscribeOptions and PullSubscribeOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SubscribeOptions.Builder<B,SO> PushSubscribeOptions can be created using a Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bind
protected ConsumerConfiguration	consumerConfig
static long	DEFAULT_ORDERED_HEARTBEAT
protected boolean	fastBind
protected long	messageAlarmTime
protected java.lang.String	name
protected boolean	ordered
protected long	pendingByteLimit
protected long	pendingMessageLimit
protected boolean	pull
protected java.lang.String	stream

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscribeOptions(SubscribeOptions.Builder builder, boolean isPull, java.lang.String deliverSubject, java.lang.String deliverGroup, long pendingMessageLimit, long pendingByteLimit)

Method Summary

Modifier and Type	Method and Description
ConsumerConfiguration	getConsumerConfiguration() Gets the consumer configuration.
java.lang.String	getDurable() Gets the durable consumer name held in the consumer configuration.
long	getMessageAlarmTime() Get the time amount of time allowed to elapse without a heartbeat.
java.lang.String	getName() Gets the name of the consumer.
long	getPendingByteLimit() Gets the pending byte limit.
long	getPendingMessageLimit() Gets the pending message limit.
java.lang.String	getStream() Gets the name of the stream.
boolean	isBind() Gets whether this subscription is expected to bind to an existing stream and consumer
boolean	isFastBind() Gets whether this subscription is expected to fast bind to an existing stream and consumer.
boolean	isOrdered() Gets whether this subscription is expected to ensure messages come in order
boolean	isPull() Gets whether this is a pull subscription
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDERED_HEARTBEAT

public static final long DEFAULT_ORDERED_HEARTBEAT

See Also:

Constant Field Values

stream

protected final java.lang.String stream

pull

protected final boolean pull

bind

protected final boolean bind

fastBind

protected final boolean fastBind

ordered

protected final boolean ordered

messageAlarmTime

protected final long messageAlarmTime

consumerConfig

protected final ConsumerConfiguration consumerConfig

pendingMessageLimit

protected final long pendingMessageLimit

pendingByteLimit

protected final long pendingByteLimit

name

protected final java.lang.String name

Constructor Detail

SubscribeOptions

protected SubscribeOptions(SubscribeOptions.Builder builder,
                           boolean isPull,
                           java.lang.String deliverSubject,
                           java.lang.String deliverGroup,
                           long pendingMessageLimit,
                           long pendingByteLimit)

Method Detail

getStream

public java.lang.String getStream()

Gets the name of the stream.

Returns:

the name of the stream.

getDurable

public java.lang.String getDurable()

Gets the durable consumer name held in the consumer configuration.

Returns:

the durable consumer name

getName

public java.lang.String getName()

Gets the name of the consumer. Same as durable when the consumer is durable.

Returns:

the name

isPull

public boolean isPull()

Gets whether this is a pull subscription

Returns:

the pull flag

isBind

public boolean isBind()

Gets whether this subscription is expected to bind to an existing stream and consumer

Returns:

the bind flag

isFastBind

public boolean isFastBind()

Gets whether this subscription is expected to fast bind to an existing stream and consumer. Overrides bind

Returns:

the fast bind flag

isOrdered

public boolean isOrdered()

Gets whether this subscription is expected to ensure messages come in order

Returns:

the ordered flag

getMessageAlarmTime

public long getMessageAlarmTime()

Get the time amount of time allowed to elapse without a heartbeat. If not set will default to 3 times the idle heartbeat setting

Returns:

the message alarm time

getConsumerConfiguration

public ConsumerConfiguration getConsumerConfiguration()

Gets the consumer configuration.

Returns:

the consumer configuration.

getPendingMessageLimit

public long getPendingMessageLimit()

Gets the pending message limit. Only applicable for non dispatched (sync) push consumers.

Returns:

the message limit

getPendingByteLimit

public long getPendingByteLimit()

Gets the pending byte limit. Only applicable for non dispatched (sync) push consumers.

Returns:

the byte limit

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object