Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassErrorResult

A error result of a request

Functions

void

cass_error_result_free

( error_result, result )

Frees an error result instance.

Parameters:
Name Type Details
error_result
in result
CassError

cass_error_result_code

( error_result )

Gets error code for the error result. This error code will always have an server error source.

Parameters:
Name Type Details
in error_result
Returns:
Type Details
CassError

The server error code
CassConsistency

cass_error_result_consistency

( error_result )

Gets consistency that triggered the error result of the following types:

  • CASS_ERROR_SERVER_READ_TIMEOUT
  • CASS_ERROR_SERVER_WRITE_TIMEOUT
  • CASS_ERROR_SERVER_UNAVAILABLE
Parameters:
Name Type Details
in error_result
Returns:
Type Details
CassConsistency

The consistency that triggered the error for a read timeout, write timeout or an unavailable error result. Undefined for other error result types.
cass_int32_t

cass_error_result_responses_received

( error_result )

Gets the acutal number of recieved responses, recieved acknowlegements or alive nodes for following error result types, respectively:

  • CASS_ERROR_SERVER_READ_TIMEOUT
  • CASS_ERROR_SERVER_WRITE_TIMEOUT
  • CASS_ERROR_SERVER_UNAVAILABLE
Parameters:
Name Type Details
in error_result
Returns:
Type Details
cass_int32_t

The actual received responses for a read timeout, actual recieved acknowlegements for a write timeout or actual alive nodes for a unavailable error. Undefined for other error result types.
cass_int32_t

cass_error_result_responses_required

( error_result )

Gets required responses, required acknowlegements or required alive nodes needed to successfully complete the request for following error result types, respectively:

  • CASS_ERROR_SERVER_READ_TIMEOUT
  • CASS_ERROR_SERVER_WRITE_TIMEOUT
  • CASS_ERROR_SERVER_UNAVAILABLE
Parameters:
Name Type Details
in error_result
Returns:
Type Details
cass_int32_t

The required responses for a read time, required acknowlegements for a write timeout or required alive nodes for an unavailable error result. Undefined for other error result types.
cass_bool_t

cass_error_result_data_present

( error_result )

Gets if the data was actually present in the responses from the replicas when the read timed out (CASS_ERROR_SERVER_READ_TIMEOUT).

Parameters:
Name Type Details
in error_result
Returns:
Type Details
cass_bool_t

cass_true if the data was present in the recieved responses when the read timeout occured. Undefined for other error result types.
CassWriteType

cass_error_result_write_type

( error_result )

Gets the write type of a request when the write timed out (CASS_ERROR_SERVER_WRITE_TIMEOUT).

Parameters:
Name Type Details
in error_result
Returns:
Type Details
CassWriteType

The type of the write that timed out. Undefined for other error result types.