![]() |
All operations that interact with the Aerospike cluster accept an as_error argument and return an as_status value. The as_error argument is populated with information about the error that occurred. The as_status return value is the as_error.code value.
When an operation succeeds, the as_error.code value is usually set to AEROSPIKE_OK
. There are some operations which may have other success status codes, so please review each operation for information on status codes.
When as_error.code is not a success value (AEROSPIKE_OK
), then you can expect the other fields of as_error.code to be populated.
Example usage:
You can reuse an as_error with multiple operations. Each operation internally resets the error. So, if an error occurred in one operation, and you did not check it, then the error will be lost with subsequent operations.
Example usage:
Definition at line 98 of file as_error.h.
#include "as_error.h"
Data Fields | |
as_status | code |
const char * | file |
const char * | func |
uint32_t | line |
char | message [AS_ERROR_MESSAGE_MAX_SIZE] |
Related Functions | |
(Note that these are not member functions.) | |
static as_error * | as_error_init (as_error *err) |
static as_status | as_error_reset (as_error *err) |
static as_status | as_error_set (as_error *err, as_status code, const char *fmt,...) |
static as_status | as_error_setall (as_error *err, as_status code, const char *message, const char *func, const char *file, uint32_t line) |
static as_status | as_error_setallv (as_error *err, as_status code, const char *func, const char *file, uint32_t line, const char *fmt,...) |
Initialize the error to default (empty) values, returning the error.
err | The error to initialize. |
Definition at line 161 of file as_error.h.
References AEROSPIKE_OK, code, file, func, line, and message.
Resets the error to default (empty) values, returning the status code.
err | The error to reset. |
Definition at line 180 of file as_error.h.
References AEROSPIKE_OK, code, file, func, line, and message.
Sets the error message
Definition at line 233 of file as_error.h.
References AS_ERROR_MESSAGE_MAX_LEN, code, and message.
|
related |
Sets the error.
Definition at line 196 of file as_error.h.
References AS_ERROR_MESSAGE_MAX_LEN, code, file, func, line, and message.
|
related |
Sets the error.
Definition at line 213 of file as_error.h.
References AS_ERROR_MESSAGE_MAX_LEN, code, file, func, line, and message.
as_status as_error::code |
Numeric error code
Definition at line 103 of file as_error.h.
const char* as_error::file |
Name of the file where the error occurred.
Definition at line 118 of file as_error.h.
const char* as_error::func |
Name of the function where the error occurred.
Definition at line 113 of file as_error.h.
uint32_t as_error::line |
Line in the file where the error occurred.
Definition at line 123 of file as_error.h.
char as_error::message[AS_ERROR_MESSAGE_MAX_SIZE] |
NULL-terminated error message
Definition at line 108 of file as_error.h.