/builddir/build/BUILD/qpid-proton-0.14.0/proton-c/include/proton/error.h File Reference

#include <proton/import_export.h>
#include <stdarg.h>

Go to the source code of this file.

Defines

#define PROTON_ERROR_H   1
#define PN_OK   (0)
#define PN_EOS   (-1)
#define PN_ERR   (-2)
#define PN_OVERFLOW   (-3)
#define PN_UNDERFLOW   (-4)
#define PN_STATE_ERR   (-5)
#define PN_ARG_ERR   (-6)
#define PN_TIMEOUT   (-7)
#define PN_INTR   (-8)
#define PN_INPROGRESS   (-9)
#define PN_OUT_OF_MEMORY   (-10)
#define PN_RETURN_IF_ERROR(x)

Typedefs

typedef struct pn_error_t pn_error_t
 A pn_error_t has an int error `code` and some string `text` to describe the error.

Functions

PN_EXTERN const char * pn_code (int code)
PN_EXTERN pn_error_tpn_error (void)
PN_EXTERN void pn_error_free (pn_error_t *error)
PN_EXTERN void pn_error_clear (pn_error_t *error)
 Reset the error to a "no error" state with code == 0.
PN_EXTERN int pn_error_set (pn_error_t *error, int code, const char *text)
 Set the error code and text.
PN_EXTERN int pn_error_vformat (pn_error_t *error, int code, const char *fmt, va_list ap)
 Set the code and set the text using a printf-style formatted string.
PN_EXTERN int pn_error_format (pn_error_t *error, int code, const char *fmt,...)
 Set the code and set the text using a printf-style formatted string.
PN_EXTERN int pn_error_code (pn_error_t *error)
PN_EXTERN const char * pn_error_text (pn_error_t *error)
PN_EXTERN int pn_error_copy (pn_error_t *error, pn_error_t *src)

Define Documentation

#define PN_ARG_ERR   (-6)
#define PN_EOS   (-1)
#define PN_ERR   (-2)
#define PN_INPROGRESS   (-9)
#define PN_INTR   (-8)
#define PN_OK   (0)
#define PN_OUT_OF_MEMORY   (-10)
#define PN_OVERFLOW   (-3)
#define PN_RETURN_IF_ERROR (  ) 
Value:
do {\
int r = (x);\
if (r < 0) return r; \
} while (0)
#define PN_STATE_ERR   (-5)
#define PN_TIMEOUT   (-7)
#define PN_UNDERFLOW   (-4)
#define PROTON_ERROR_H   1

Typedef Documentation

typedef struct pn_error_t pn_error_t

A pn_error_t has an int error `code` and some string `text` to describe the error.


Function Documentation

PN_EXTERN const char* pn_code ( int  code  ) 
Returns:
name of the error code. Returned pointer is to a static constant, do not delete.
PN_EXTERN pn_error_t* pn_error ( void   ) 
PN_EXTERN void pn_error_clear ( pn_error_t error  ) 

Reset the error to a "no error" state with code == 0.

PN_EXTERN int pn_error_code ( pn_error_t error  ) 
Returns:
the error code.
PN_EXTERN int pn_error_copy ( pn_error_t error,
pn_error_t src 
)
PN_EXTERN int pn_error_format ( pn_error_t error,
int  code,
const char *  fmt,
  ... 
)

Set the code and set the text using a printf-style formatted string.

PN_EXTERN void pn_error_free ( pn_error_t error  ) 
PN_EXTERN int pn_error_set ( pn_error_t error,
int  code,
const char *  text 
)

Set the error code and text.

Makes a copy of text.

PN_EXTERN const char* pn_error_text ( pn_error_t error  ) 
Returns:
the error text. Returned pointer is owned by the pn_error_t.
PN_EXTERN int pn_error_vformat ( pn_error_t error,
int  code,
const char *  fmt,
va_list  ap 
)

Set the code and set the text using a printf-style formatted string.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 23 Sep 2016 for proton by  doxygen 1.6.1