apr  1.7.0
About: APR (Apache Portable Runtime) project offers software libraries that provide a predictable and consistent interface to underlying platform-specific implementations (APR core library).
  Fossies Dox: apr-1.7.0.tar.bz2  ("inofficial" and yet experimental doxygen-generated source code documentation)  

Error Codes
Collaboration diagram for Error Codes:

Modules

 APR Error Space
 
 APR Error Values
 
 Status Value Tests
 

Macros

#define APR_OS_START_ERROR   20000
 
#define APR_OS_ERRSPACE_SIZE   50000
 
#define APR_UTIL_ERRSPACE_SIZE   20000
 
#define APR_OS_START_STATUS   (APR_OS_START_ERROR + APR_OS_ERRSPACE_SIZE)
 
#define APR_UTIL_START_STATUS
 
#define APR_OS_START_USERERR   (APR_OS_START_STATUS + APR_OS_ERRSPACE_SIZE)
 
#define APR_OS_START_USEERR   APR_OS_START_USERERR
 
#define APR_OS_START_CANONERR
 
#define APR_OS_START_EAIERR   (APR_OS_START_CANONERR + APR_OS_ERRSPACE_SIZE)
 
#define APR_OS_START_SYSERR   (APR_OS_START_EAIERR + APR_OS_ERRSPACE_SIZE)
 
#define APR_SUCCESS   0
 
#define APR_FROM_OS_ERROR(e)   (e)
 
#define APR_TO_OS_ERROR(e)   (e)
 
#define apr_get_os_error()   (errno)
 
#define apr_set_os_error(e)   (errno = (e))
 
#define apr_get_netos_error()   (errno)
 
#define apr_set_netos_error(e)   (errno = (e))
 

Typedefs

typedef int apr_status_t
 

Functions

 APR_DECLARE (char *) apr_strerror(apr_status_t statcode
 

Variables

char * buf
 
char apr_size_t bufsize
 

Detailed Description

Macro Definition Documentation

◆ APR_FROM_OS_ERROR

#define APR_FROM_OS_ERROR (   e)    (e)

Definition at line 1214 of file apr_errno.h.

◆ apr_get_netos_error

#define apr_get_netos_error ( )    (errno)

Definition at line 1222 of file apr_errno.h.

◆ apr_get_os_error

#define apr_get_os_error ( )    (errno)

Definition at line 1217 of file apr_errno.h.

◆ APR_OS_ERRSPACE_SIZE

#define APR_OS_ERRSPACE_SIZE   50000

APR_OS_ERRSPACE_SIZE is the maximum number of errors you can fit into one of the error/status ranges below – except for APR_OS_START_USERERR, which see.

Definition at line 123 of file apr_errno.h.

◆ APR_OS_START_CANONERR

#define APR_OS_START_CANONERR
Value:

APR_OS_START_CANONERR is where APR versions of errno values are defined on systems which don't have the corresponding errno.

Definition at line 174 of file apr_errno.h.

◆ APR_OS_START_EAIERR

#define APR_OS_START_EAIERR   (APR_OS_START_CANONERR + APR_OS_ERRSPACE_SIZE)

APR_OS_START_EAIERR folds EAI_ error codes from getaddrinfo() into apr_status_t values.

Definition at line 180 of file apr_errno.h.

◆ APR_OS_START_ERROR

#define APR_OS_START_ERROR   20000

APR_OS_START_ERROR is where the APR specific error values start.

Definition at line 117 of file apr_errno.h.

◆ APR_OS_START_STATUS

#define APR_OS_START_STATUS   (APR_OS_START_ERROR + APR_OS_ERRSPACE_SIZE)

APR_OS_START_STATUS is where the APR specific status codes start.

Definition at line 136 of file apr_errno.h.

◆ APR_OS_START_SYSERR

#define APR_OS_START_SYSERR   (APR_OS_START_EAIERR + APR_OS_ERRSPACE_SIZE)

APR_OS_START_SYSERR folds platform-specific system error values into apr_status_t values.

Definition at line 185 of file apr_errno.h.

◆ APR_OS_START_USEERR

#define APR_OS_START_USEERR   APR_OS_START_USERERR

APR_OS_START_USEERR is obsolete, defined for compatibility only. Use APR_OS_START_USERERR instead.

Definition at line 169 of file apr_errno.h.

◆ APR_OS_START_USERERR

#define APR_OS_START_USERERR   (APR_OS_START_STATUS + APR_OS_ERRSPACE_SIZE)

APR_OS_START_USERERR are reserved for applications that use APR that layer their own error codes along with APR's. Note that the error immediately following this one is set ten times farther away than usual, so that users of apr have a lot of room in which to declare custom error codes.

In general applications should try and create unique error codes. To try and assist in finding suitable ranges of numbers to use, the following ranges are known to be used by the listed applications. If your application defines error codes please advise the range of numbers it uses to dev@a.nosp@m.pr.a.nosp@m.pache.nosp@m..org for inclusion in this list.

Ranges shown are in relation to APR_OS_START_USERERR

Subversion - Defined ranges, of less than 100, at intervals of 5000 starting at an offset of 5000, e.g. +5000 to 5100, +10000 to 10100

Apache HTTPD - +2000 to 2999

Definition at line 164 of file apr_errno.h.

◆ apr_set_netos_error

#define apr_set_netos_error (   e)    (errno = (e))

Definition at line 1223 of file apr_errno.h.

◆ apr_set_os_error

#define apr_set_os_error (   e)    (errno = (e))

Definition at line 1218 of file apr_errno.h.

◆ APR_SUCCESS

#define APR_SUCCESS   0

no error.

Definition at line 225 of file apr_errno.h.

◆ APR_TO_OS_ERROR

#define APR_TO_OS_ERROR (   e)    (e)

Definition at line 1215 of file apr_errno.h.

◆ APR_UTIL_ERRSPACE_SIZE

#define APR_UTIL_ERRSPACE_SIZE   20000

APR_UTIL_ERRSPACE_SIZE is the size of the space that is reserved for use within apr-util. This space is reserved above that used by APR internally.

Note
This number MUST be smaller than APR_OS_ERRSPACE_SIZE by a large enough amount that APR has sufficient room for its codes.

Definition at line 132 of file apr_errno.h.

◆ APR_UTIL_START_STATUS

#define APR_UTIL_START_STATUS
Value:

APR_UTIL_START_STATUS is where APR-Util starts defining its status codes.

Definition at line 141 of file apr_errno.h.

Typedef Documentation

◆ apr_status_t

typedef int apr_status_t

Type for specifying an error or status code.

Definition at line 44 of file apr_errno.h.

Function Documentation

◆ APR_DECLARE()

APR_DECLARE ( char *  )

Return a human readable string describing the specified error.

Parameters
statcodeThe error code to get a string for.
bufA buffer to hold the error string.
bufsizeSize of the buffer to hold the string.

Variable Documentation

◆ buf

◆ bufsize

char apr_size_t bufsize
APR_UTIL_ERRSPACE_SIZE
#define APR_UTIL_ERRSPACE_SIZE
Definition: apr_errno.h:132
APR_OS_START_STATUS
#define APR_OS_START_STATUS
Definition: apr_errno.h:136
APR_OS_ERRSPACE_SIZE
#define APR_OS_ERRSPACE_SIZE
Definition: apr_errno.h:123
APR_OS_START_USERERR
#define APR_OS_START_USERERR
Definition: apr_errno.h:164