Qpid Proton C API 0.40.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/annotations.h>
26#include <proton/import_export.h>
27#include <stdarg.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
45typedef struct pn_error_t pn_error_t;
46
47#define PN_OK (0)
48#define PN_EOS (-1)
49#define PN_ERR (-2)
50#define PN_OVERFLOW (-3)
51#define PN_UNDERFLOW (-4)
52#define PN_STATE_ERR (-5)
53#define PN_ARG_ERR (-6)
54#define PN_TIMEOUT (-7)
55#define PN_INTR (-8)
56#define PN_INPROGRESS (-9)
57#define PN_OUT_OF_MEMORY (-10)
58#define PN_ABORTED (-11)
64PN_EXTERN const char *pn_code(int code);
65
69PN_EXTERN pn_error_t *pn_error(void);
70
74PN_EXTERN void pn_error_free(pn_error_t *error);
75
79PN_EXTERN void pn_error_clear(pn_error_t *error);
80
84PN_EXTERN int pn_error_set(pn_error_t *error, int code, const char *text);
85
90PN_EXTERN int pn_error_vformat(pn_error_t *error, int code, const char *fmt, va_list ap);
91
96PN_EXTERN int pn_error_format(pn_error_t *error, int code, PN_PRINTF_FORMAT const char *fmt, ...)
97 PN_PRINTF_FORMAT_ATTR(3, 4);
98
102PN_EXTERN int pn_error_code(pn_error_t *error);
103
108PN_EXTERN const char *pn_error_text(pn_error_t *error);
109
113PN_EXTERN int pn_error_copy(pn_error_t *error, pn_error_t *src);
114
118#define PN_RETURN_IF_ERROR(x) \
119do {\
120int r = (x);\
121if (r < 0) return r; \
122} while (0)
131#ifdef __cplusplus
132}
133#endif
134
135#endif /* error.h */
int pn_error_format(pn_error_t *error, int code, PN_PRINTF_FORMAT const char *fmt,...) PN_PRINTF_FORMAT_ATTR(3
Set the code and set the text using a printf-style formatted string.
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:45
int int pn_error_code(pn_error_t *error)
Get the the error code.
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_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.