Class LoggingRetryPolicy

A retry policy that wraps another policy, logging the decision made by its sub-policy.

Note that this policy only log the Ignore and Retry decisions (since Rethrow decisions just amount to propagate the cassandra exception). The logging is done at the Info level.

Inheritance

object

LoggingRetryPolicy

Implements

IExtendedRetryPolicy

IRetryPolicy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Cassandra

Assembly: Cassandra.dll

Syntax

public class LoggingRetryPolicy : IExtendedRetryPolicy, IRetryPolicy

Constructors

LoggingRetryPolicy(IRetryPolicy)

Creates a new IExtendedRetryPolicy that logs the decision of the provided policy.

Declaration

public LoggingRetryPolicy(IRetryPolicy policy)

Parameters

Type	Name	Description
IRetryPolicy	policy	the policy to wrap. The policy created by this constructor will return the same decision than `policy` but will log them.

Properties

ChildPolicy

Declaration

public IRetryPolicy ChildPolicy { get; }

Property Value

Type	Description
IRetryPolicy

Methods

OnReadTimeout(IStatement, ConsistencyLevel, int, int, bool, int)

Defines whether to retry and at which consistency level on a read timeout.

Note that this method may be called even if requiredResponses >= receivedResponses if dataPresent is false (see com.datastax.driver.core.exceptions.ReadTimeoutException#WasDataRetrieved).

Declaration

public RetryDecision OnReadTimeout(IStatement query, ConsistencyLevel cl, int requiredResponses, int receivedResponses, bool dataRetrieved, int nbRetry)

Parameters

Type	Name	Description
IStatement	query	the original query that timeouted.
ConsistencyLevel	cl	the original consistency level of the read that timeouted.
int	requiredResponses	the number of responses that were required to achieve the requested consistency level.
int	receivedResponses	the number of responses that had been received by the time the timeout exception was raised.
bool	dataRetrieved	whether actual data (by opposition to data checksum) was present in the received responses.
int	nbRetry	the number of retry already performed for this operation.

Returns

Type	Description
RetryDecision	the retry decision. If `RetryDecision.Rethrow` is returned, a com.datastax.driver.core.exceptions.ReadTimeoutException will be thrown for the operation.

OnRequestError(IStatement, Configuration, Exception, int)

Defines whether to retry and at which consistency level on an unexpected error.

This method might be invoked in the following situations:

On a client timeout, while waiting for the server response (see ReadTimeoutMillis).
On a socket error (socket closed, etc.).
When the contacted host replies with an OVERLOADED error or a SERVER_ERROR.

Note that when such an error occurs, there is no guarantee that the mutation has been applied server-side or not.

Declaration

public RetryDecision OnRequestError(IStatement statement, Configuration config, Exception ex, int nbRetry)

Parameters

Type	Name	Description
IStatement	statement	The original query that failed.
Configuration	config	The current cluster configuration.
Exception	ex	The exception that caused this request to fail.
int	nbRetry	The number of retries already performed for this operation.

Returns

Type	Description
RetryDecision

OnUnavailable(IStatement, ConsistencyLevel, int, int, int)

Defines whether to retry and at which consistency level on an unavailable exception.

Declaration

public RetryDecision OnUnavailable(IStatement query, ConsistencyLevel cl, int requiredReplica, int aliveReplica, int nbRetry)

Parameters

Type	Name	Description
IStatement	query	the original query for which the consistency level cannot be achieved.
ConsistencyLevel	cl	the original consistency level for the operation.
int	requiredReplica	the number of replica that should have been (known) alive for the operation to be attempted.
int	aliveReplica	the number of replica that were know to be alive by the coordinator of the operation.
int	nbRetry	the number of retry already performed for this operation.

Returns

Type	Description
RetryDecision	the retry decision. If `RetryDecision.Rethrow` is returned, an com.datastax.driver.core.exceptions.UnavailableException will be thrown for the operation.

OnWriteTimeout(IStatement, ConsistencyLevel, string, int, int, int)

Defines whether to retry and at which consistency level on a write timeout.

Declaration

public RetryDecision OnWriteTimeout(IStatement query, ConsistencyLevel cl, string writeType, int requiredAcks, int receivedAcks, int nbRetry)

Parameters

Type	Name	Description
IStatement	query	the original query that timeouted.
ConsistencyLevel	cl	the original consistency level of the write that timeouted.
string	writeType	the type of the write that timeouted.
int	requiredAcks	the number of acknowledgments that were required to achieve the requested consistency level.
int	receivedAcks	the number of acknowledgments that had been received by the time the timeout exception was raised.
int	nbRetry	the number of retry already performed for this operation.

Returns

Type	Description
RetryDecision	the retry decision. If `RetryDecision.Rethrow` is returned, a com.datastax.driver.core.exceptions.WriteTimeoutException will be thrown for the operation.

Implements

IExtendedRetryPolicy

IRetryPolicy