Qpid Proton C API 0.39.0
 
Loading...
Searching...
No Matches
error.h
Go to the documentation of this file.
1#ifndef PROTON_ERROR_H
2#define PROTON_ERROR_H 1
3
4/*
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements. See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership. The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License. You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied. See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 */
24
25#include <proton/import_export.h>
26#include <stdarg.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
44typedef struct pn_error_t pn_error_t;
45
46#define PN_OK (0)
47#define PN_EOS (-1)
48#define PN_ERR (-2)
49#define PN_OVERFLOW (-3)
50#define PN_UNDERFLOW (-4)
51#define PN_STATE_ERR (-5)
52#define PN_ARG_ERR (-6)
53#define PN_TIMEOUT (-7)
54#define PN_INTR (-8)
55#define PN_INPROGRESS (-9)
56#define PN_OUT_OF_MEMORY (-10)
57#define PN_ABORTED (-11)
63PN_EXTERN const char *pn_code(int code);
64
68PN_EXTERN pn_error_t *pn_error(void);
69
73PN_EXTERN void pn_error_free(pn_error_t *error);
74
78PN_EXTERN void pn_error_clear(pn_error_t *error);
79
83PN_EXTERN int pn_error_set(pn_error_t *error, int code, const char *text);
84
89PN_EXTERN int pn_error_vformat(pn_error_t *error, int code, const char *fmt, va_list ap);
90
95PN_EXTERN int pn_error_format(pn_error_t *error, int code, const char *fmt, ...);
96
100PN_EXTERN int pn_error_code(pn_error_t *error);
101
106PN_EXTERN const char *pn_error_text(pn_error_t *error);
107
111PN_EXTERN int pn_error_copy(pn_error_t *error, pn_error_t *src);
112
116#define PN_RETURN_IF_ERROR(x) \
117do {\
118int r = (x);\
119if (r < 0) return r; \
120} while (0)
129#ifdef __cplusplus
130}
131#endif
132
133#endif /* error.h */
int pn_error_code(pn_error_t *error)
Get the the error code.
void pn_error_clear(pn_error_t *error)
Reset the error to a "no error" state with code == 0.
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition: error.h:44
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.
void pn_error_free(pn_error_t *error)
Free an error object.
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.
int pn_error_copy(pn_error_t *error, pn_error_t *src)
Copy the src error.
int pn_error_set(pn_error_t *error, int code, const char *text)
Set the error code and text.
const char * pn_error_text(pn_error_t *error)
Get the error text.
const char * pn_code(int code)
Get the name of the error code.
pn_error_t * pn_error(void)
Create an error object.