com.couchbase.client.dcp.highlevel

Enum FlowControlMode

java.lang.Object

java.lang.Enum<FlowControlMode>

com.couchbase.client.dcp.highlevel.FlowControlMode

All Implemented Interfaces:

Serializable, Comparable<FlowControlMode>

public enum FlowControlMode
extends Enum<FlowControlMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC In this mode, Mutation and Deletion events are automatically acknowledged prior to dispatch to the DatabaseChangeListener.
MANUAL In this mode, the listener is responsible for calling DocumentChange.flowControlAck() after each Mutation and Deletion event is processed.

Method Summary

Modifier and Type	Method and Description
static FlowControlMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FlowControlMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final FlowControlMode AUTOMATIC

In this mode, Mutation and Deletion events are automatically acknowledged prior to dispatch to the DatabaseChangeListener.

Suitable for listeners whose DatabaseChangeListener.onMutation(Mutation) and DatabaseChangeListener.onDeletion(Deletion) methods either completely process the event (for example, by writing it to disk) or implictly generate backpressure (for example, by writing the event to a bounded blocking queue).

MANUAL

public static final FlowControlMode MANUAL

In this mode, the listener is responsible for calling DocumentChange.flowControlAck() after each Mutation and Deletion event is processed.

NOTE: This mode is not recommended, since it can be difficult to ensure events are acknowledged on all code paths, and failure to ACK can cause the server to stop sending events.

Method Detail

values

public static FlowControlMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FlowControlMode c : FlowControlMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FlowControlMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null