All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Related Functions
as_error Struct Reference

Detailed Description

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:

if ( aerospike_key_get(&as, &err, NULL, &key, &rec) != AEROSPIKE_OK ) {
fprintf(stderr, "(%d) %s at %s[%s:%d]\n", error.code, err.message, err.func, err.file. err.line);
}

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:

if ( aerospike_key_put(&as, &err, NULL, &key, rec) != AEROSPIKE_OK ) {
fprintf(stderr, "(%d) %s at %s[%s:%d]\n", error.code, err.message, err.func, err.file. err.line);
}
if ( aerospike_key_get(&as, &err, NULL, &key, &rec) != AEROSPIKE_OK ) {
fprintf(stderr, "(%d) %s at %s[%s:%d]\n", error.code, err.message, err.func, err.file. err.line);
}

Definition at line 98 of file as_error.h.

#include "as_error.h"

+ Collaboration diagram for as_error:

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.)

as_erroras_error_init (as_error *err)
 
as_status as_error_reset (as_error *err)
 
as_status as_error_set (as_error *err, as_status code, const char *fmt,...)
 
as_status as_error_setall (as_error *err, as_status code, const char *message, const char *func, const char *file, uint32_t line)
 
as_status as_error_setallv (as_error *err, as_status code, const char *func, const char *file, uint32_t line, const char *fmt,...)
 

Friends And Related Function Documentation

as_error * as_error_init ( as_error err)
related

Initialize the error to default (empty) values, returning the error.

Parameters
errThe error to initialize.
Returns
The initialized err.

Definition at line 153 of file as_error.h.

References AEROSPIKE_OK, code, file, func, line, and message.

as_status as_error_reset ( as_error err)
related

Resets the error to default (empty) values, returning the status code.

Parameters
errThe error to reset.
Returns
AEROSPIKE_OK.

Definition at line 172 of file as_error.h.

References AEROSPIKE_OK, code, file, func, line, and message.

as_status as_error_set ( as_error err,
as_status  code,
const char *  fmt,
  ... 
)
related

Sets the error message

Definition at line 225 of file as_error.h.

References AS_ERROR_MESSAGE_MAX_LEN, code, and message.

as_status as_error_setall ( as_error err,
as_status  code,
const char *  message,
const char *  func,
const char *  file,
uint32_t  line 
)
related

Sets the error.

Returns
The status code set for the error.

Definition at line 188 of file as_error.h.

References AS_ERROR_MESSAGE_MAX_LEN, code, file, func, line, and message.

as_status as_error_setallv ( as_error err,
as_status  code,
const char *  func,
const char *  file,
uint32_t  line,
const char *  fmt,
  ... 
)
related

Sets the error.

Returns
The status code set for the error.

Definition at line 205 of file as_error.h.

References AS_ERROR_MESSAGE_MAX_LEN, code, file, func, line, and message.

Field Documentation

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.


The documentation for this struct was generated from the following file: