00001 #ifndef PROTON_ERROR_H 00002 #define PROTON_ERROR_H 1 00003 00004 /* 00005 * 00006 * Licensed to the Apache Software Foundation (ASF) under one 00007 * or more contributor license agreements. See the NOTICE file 00008 * distributed with this work for additional information 00009 * regarding copyright ownership. The ASF licenses this file 00010 * to you under the Apache License, Version 2.0 (the 00011 * "License"); you may not use this file except in compliance 00012 * with the License. You may obtain a copy of the License at 00013 * 00014 * http://www.apache.org/licenses/LICENSE-2.0 00015 * 00016 * Unless required by applicable law or agreed to in writing, 00017 * software distributed under the License is distributed on an 00018 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 00019 * KIND, either express or implied. See the License for the 00020 * specific language governing permissions and limitations 00021 * under the License. 00022 * 00023 */ 00024 00025 #include <proton/import_export.h> 00026 #include <stdarg.h> 00027 00028 #ifdef __cplusplus 00029 extern "C" { 00030 #endif 00031 00032 /** A pn_error_t has an int error `code` and some string `text` to describe the error */ 00033 typedef struct pn_error_t pn_error_t; 00034 00035 #define PN_OK (0) 00036 #define PN_EOS (-1) 00037 #define PN_ERR (-2) 00038 #define PN_OVERFLOW (-3) 00039 #define PN_UNDERFLOW (-4) 00040 #define PN_STATE_ERR (-5) 00041 #define PN_ARG_ERR (-6) 00042 #define PN_TIMEOUT (-7) 00043 #define PN_INTR (-8) 00044 #define PN_INPROGRESS (-9) 00045 #define PN_OUT_OF_MEMORY (-10) 00046 00047 /** @return name of the error code. Returned pointer is to a static constant, do not delete.*/ 00048 PN_EXTERN const char *pn_code(int code); 00049 00050 PN_EXTERN pn_error_t *pn_error(void); 00051 PN_EXTERN void pn_error_free(pn_error_t *error); 00052 00053 /** Reset the error to a "no error" state with code == 0. */ 00054 PN_EXTERN void pn_error_clear(pn_error_t *error); 00055 00056 /** Set the error code and text. Makes a copy of text. */ 00057 PN_EXTERN int pn_error_set(pn_error_t *error, int code, const char *text); 00058 00059 /** Set the code and set the text using a printf-style formatted string. */ 00060 PN_EXTERN int pn_error_vformat(pn_error_t *error, int code, const char *fmt, va_list ap); 00061 00062 /** Set the code and set the text using a printf-style formatted string. */ 00063 PN_EXTERN int pn_error_format(pn_error_t *error, int code, const char *fmt, ...); 00064 00065 /** @return the error code. */ 00066 PN_EXTERN int pn_error_code(pn_error_t *error); 00067 00068 /** @return the error text. Returned pointer is owned by the pn_error_t. */ 00069 PN_EXTERN const char *pn_error_text(pn_error_t *error); 00070 00071 PN_EXTERN int pn_error_copy(pn_error_t *error, pn_error_t *src); 00072 00073 #define PN_RETURN_IF_ERROR(x) \ 00074 do {\ 00075 int r = (x);\ 00076 if (r < 0) return r; \ 00077 } while (0) 00078 00079 #ifdef __cplusplus 00080 } 00081 #endif 00082 00083 #endif /* error.h */