Package com.couchbase.client.core.msg
Enum CancellationReason
- java.lang.Object
-
- java.lang.Enum<CancellationReason>
-
- com.couchbase.client.core.msg.CancellationReason
-
- All Implemented Interfaces:
Serializable
,Comparable<CancellationReason>
public enum CancellationReason extends Enum<CancellationReason>
Describes the reason why aRequest
has been cancelled.- Since:
- 2.0.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CANCELLED_VIA_CONTEXT
The user or some other code proactively cancelled the request by cancelling it through its attached context.IO_CLOSED_WHILE_IN_FLIGHT
The request was in-flight on the socket and the socket got closed.NO_MORE_RETRIES
The retry strategy decided that no more retries were allowed/possible.OTHER
For a different reason.SHUTDOWN
The SDK has been shut down already when this request is dispatched.STOPPED_LISTENING
The downstream consumer stopped listening for a result and therefore any further processing is a waste of resources.TIMEOUT
The request ran into a timeout and is therefore cancelled before it got a chance to complete.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CancellationReason
valueOf(String name)
Returns the enum constant of this type with the specified name.static CancellationReason[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
STOPPED_LISTENING
public static final CancellationReason STOPPED_LISTENING
The downstream consumer stopped listening for a result and therefore any further processing is a waste of resources.
-
TIMEOUT
public static final CancellationReason TIMEOUT
The request ran into a timeout and is therefore cancelled before it got a chance to complete.
-
CANCELLED_VIA_CONTEXT
public static final CancellationReason CANCELLED_VIA_CONTEXT
The user or some other code proactively cancelled the request by cancelling it through its attached context.
-
NO_MORE_RETRIES
public static final CancellationReason NO_MORE_RETRIES
The retry strategy decided that no more retries were allowed/possible.
-
IO_CLOSED_WHILE_IN_FLIGHT
public static final CancellationReason IO_CLOSED_WHILE_IN_FLIGHT
The request was in-flight on the socket and the socket got closed.
-
SHUTDOWN
public static final CancellationReason SHUTDOWN
The SDK has been shut down already when this request is dispatched.
-
OTHER
public static final CancellationReason OTHER
For a different reason. Make sure to emit an event so that debugging provides further context.
-
-
Method Detail
-
values
public static CancellationReason[] 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 (CancellationReason c : CancellationReason.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CancellationReason 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 nameNullPointerException
- if the argument is null
-
-