return codes

Collaboration diagram for return codes:

Macros
#define	VOLK_OK   0
	Generic success return code.
#define	VOLK_NOACTION   88801
	No action taken.
#define	VOLK_NORESULT   88802
	No result yielded.
#define	VOLK_END   88803
	Loop end.
#define	VOLK_CONFLICT   88804
	Conflict warning.
#define	VOLK_ERROR   -88899
	Generic error return code.
#define	VOLK_PARSE_ERR   -88898
	Codec parser error.
#define	VOLK_VALUE_ERR   -88897
	An invalid input value was provided.
#define	VOLK_TXN_ERR   -88896
	Error handling a store transaction.
#define	VOLK_DB_ERR   -88895
	Low-level database error.
#define	VOLK_NOT_IMPL_ERR   -88894
	Functionality is not implemented.
#define	VOLK_IO_ERR   -88893
	I/O error.
#define	VOLK_MEM_ERR   -88892
	Memory allocation error.
#define	VOLK_CONFLICT_ERR   -88891
	Conflict error.
#define	VOLK_ENV_ERR   -88890
	Error while handling environment setup; or environment not initialized.

Typedefs
typedef int	VOLK_rc

Functions
const char *	VOLK_strerror (VOLK_rc rc)
	Return an error message for a return code.

Detailed Description

0 is success, positive integers (>88800) are warnings, and negative integers (>-88900) are errors.

Macro Definition Documentation

VOLK_OK

#define VOLK_OK   0

Generic success return code.

Definition at line 83 of file core.h.

VOLK_NOACTION

#define VOLK_NOACTION   88801

No action taken.

An attempt to create or update a resource was made, but the resource already existed substantially in the same form, so no action took place. The caller is expected to find the resource as though the action actually took place. If this is returned from the iteration of multiple updates, it means that none of the iterations produced a change in state.

Definition at line 93 of file core.h.

VOLK_NORESULT

#define VOLK_NORESULT   88802

No result yielded.

A read operation returned no results. If an iterator is expected to be created, it may be created empty.

Definition at line 100 of file core.h.

VOLK_END

#define VOLK_END   88803

Loop end.

End of a loop was reached. This can be used in a while() or for() loop as a terminating condition.

Definition at line 107 of file core.h.

VOLK_CONFLICT

#define VOLK_CONFLICT   88804

Conflict warning.

An attempt to create or update a resource was made, but the resource existed with a different form or value. The caller should find the value of the existing resource to be different than the one that was attempted to store. If this is returned from the iteration of multiple updates, it means that some resources in the loop may have changed state and the operation as a whole completed successfully.

The error-level counterpart to this is VOLK_CONFLICT_ERR.

Definition at line 120 of file core.h.

VOLK_ERROR

#define VOLK_ERROR   -88899

Generic error return code.

Definition at line 123 of file core.h.

VOLK_PARSE_ERR

#define VOLK_PARSE_ERR   -88898

Codec parser error.

Definition at line 126 of file core.h.

VOLK_VALUE_ERR

#define VOLK_VALUE_ERR   -88897

An invalid input value was provided.

Definition at line 129 of file core.h.

VOLK_TXN_ERR

#define VOLK_TXN_ERR   -88896

Error handling a store transaction.

Definition at line 132 of file core.h.

VOLK_DB_ERR

#define VOLK_DB_ERR   -88895

Low-level database error.

Definition at line 135 of file core.h.

VOLK_NOT_IMPL_ERR

#define VOLK_NOT_IMPL_ERR   -88894

Functionality is not implemented.

Definition at line 138 of file core.h.

VOLK_IO_ERR

#define VOLK_IO_ERR   -88893

I/O error.

Definition at line 141 of file core.h.

VOLK_MEM_ERR

#define VOLK_MEM_ERR   -88892

Memory allocation error.

Definition at line 144 of file core.h.

VOLK_CONFLICT_ERR

#define VOLK_CONFLICT_ERR   -88891

Conflict error.

A critical resource conflict happened and no resources were updated. If this is returned from the iteration of multiple updates, it means that the operation has been interrupted and any state change within the loop prior to the error has been rolled back.

The warning-level counterpart to this is VOLK_CONFLICT.

Definition at line 155 of file core.h.

VOLK_ENV_ERR

#define VOLK_ENV_ERR   -88890

Error while handling environment setup; or environment not initialized.

Definition at line 158 of file core.h.

Typedef Documentation

VOLK_rc

typedef int VOLK_rc

Definition at line 79 of file core.h.

Function Documentation

VOLK_strerror()

const char * VOLK_strerror

(

VOLK_rc

rc

)

Return an error message for a return code.

Definition at line 196 of file core.c.