Package com.couchbase.client.core.msg
Class CancellationReason
- java.lang.Object
-
- com.couchbase.client.core.msg.CancellationReason
-
-
Field Summary
Fields Modifier and Type Field Description static CancellationReasonCANCELLED_VIA_CONTEXTThe user or some other code proactively cancelled the request by cancelling it through its attached context.static CancellationReasonOTHERFor a different reason.static CancellationReasonSERVER_CANCELLEDThe server reported that it cancelled the request.static CancellationReasonSHUTDOWNThe SDK has been shut down already when this request is dispatched.static CancellationReasonSTOPPED_LISTENINGThe downstream consumer stopped listening for a result and therefore any further processing is a waste of resources.static CancellationReasonTARGET_NODE_REMOVEDWhen aTargetedRequestis dispatched but the list of nodes does not contain the target at all, there is good chance that this request will not be able to make progress anymore so it will be cancelled.static CancellationReasonTIMEOUTThe request ran into a timeout and is therefore cancelled before it got a chance to complete.static CancellationReasonTOO_MANY_REQUESTS_IN_RETRYIf too many outstanding requests are waiting to be completed.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)inthashCode()Stringidentifier()Returns the identifier for this reason.ObjectinnerReason()If applicable, returns an inner reason for the cancellation for additional context.static CancellationReasonnoMoreRetries(RetryReason retryReason)This cancellation reason indicates that no more retries were allowed based on the retry strategy.StringtoString()
-
-
-
Field 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.
-
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.
-
TOO_MANY_REQUESTS_IN_RETRY
public static final CancellationReason TOO_MANY_REQUESTS_IN_RETRY
If too many outstanding requests are waiting to be completed. This is the SDK backpressure signal.
-
TARGET_NODE_REMOVED
public static final CancellationReason TARGET_NODE_REMOVED
When aTargetedRequestis dispatched but the list of nodes does not contain the target at all, there is good chance that this request will not be able to make progress anymore so it will be cancelled.Request creators are advised to grab a fresh config, a new target, and re-dispatch the operation to give it a chance to make progress eventually.
-
SERVER_CANCELLED
public static final CancellationReason SERVER_CANCELLED
The server reported that it cancelled the request.
-
-
Method Detail
-
noMoreRetries
public static CancellationReason noMoreRetries(RetryReason retryReason)
This cancellation reason indicates that no more retries were allowed based on the retry strategy.- Parameters:
retryReason- the retry reason why it got sent into retry.- Returns:
- the cancellation reason instance.
-
innerReason
public Object innerReason()
If applicable, returns an inner reason for the cancellation for additional context.
-
identifier
public String identifier()
Returns the identifier for this reason.
-
-