libSRTP
err.h
1/*
2 * err.h
3 *
4 * error status codes
5 *
6 * David A. McGrew
7 * Cisco Systems, Inc.
8 */
9/*
10 *
11 * Copyright (c) 2001-2017, Cisco Systems, Inc.
12 * All rights reserved.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 *
18 * Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 *
21 * Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials provided
24 * with the distribution.
25 *
26 * Neither the name of the Cisco Systems, Inc. nor the names of its
27 * contributors may be used to endorse or promote products derived
28 * from this software without specific prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
33 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
34 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
35 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
36 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
37 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
41 * OF THE POSSIBILITY OF SUCH DAMAGE.
42 *
43 */
44
45#ifndef ERR_H
46#define ERR_H
47
48#include <stdio.h>
49#include <stdarg.h>
50#include "srtp.h"
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
68typedef enum {
69 srtp_err_level_error,
70 srtp_err_level_warning,
71 srtp_err_level_info,
72 srtp_err_level_debug
73} srtp_err_reporting_level_t;
74
75/*
76 * err_reporting_init prepares the error system. If
77 * ERR_REPORTING_STDOUT is defined, it will log to stdout.
78 *
79 */
80
81srtp_err_status_t srtp_err_reporting_init(void);
82
83typedef void(srtp_err_report_handler_func_t)(srtp_err_reporting_level_t level,
84 const char *msg);
85
86srtp_err_status_t srtp_install_err_report_handler(
87 srtp_err_report_handler_func_t func);
88
89/*
90 * srtp_err_report reports a 'printf' formatted error
91 * string, followed by a an arg list. The level argument
92 * is one of srtp_err_reporting_level_t.
93 *
94 * Errors will be reported to stdout, if ERR_REPORTING_STDOUT
95 * is defined.
96 *
97 */
98
99void srtp_err_report(srtp_err_reporting_level_t level, const char *format, ...);
100
101/*
102 * debug_module_t defines a debug module
103 */
104
105typedef struct {
106 int on; /* 1 if debugging is on, 0 if it is off */
107 const char *name; /* printable name for debug module */
109
110#ifdef ENABLE_DEBUG_LOGGING
111
112#define debug_print0(mod, format) \
113 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name)
114#define debug_print(mod, format, arg) \
115 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
116#define debug_print2(mod, format, arg1, arg2) \
117 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
118 arg1, arg2)
119
120#else
121
122#define debug_print0(mod, format) \
123 if (mod.on) \
124 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name)
125#define debug_print(mod, format, arg) \
126 if (mod.on) \
127 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
128#define debug_print2(mod, format, arg1, arg2) \
129 if (mod.on) \
130 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
131 arg1, arg2)
132
133#endif
134
135#ifdef __cplusplus
136}
137#endif
138
139#endif /* ERR_H */
srtp_err_status_t
srtp_err_status_t defines error codes.
Definition srtp.h:164
Definition err.h:105