libSRTP 2.6.0
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#if defined(__clang__) || (defined(__GNUC__) && defined(__has_attribute))
53#if __has_attribute(format)
54#define LIBSRTP_FORMAT_PRINTF(fmt, args) \
55 __attribute__((format(__printf__, fmt, args)))
56#else
57#define LIBSRTP_FORMAT_PRINTF(fmt, args)
58#endif
59#else
60#define LIBSRTP_FORMAT_PRINTF(fmt, args)
61#endif
62
63#ifdef __cplusplus
64extern "C" {
65#endif
66
79typedef enum {
80 srtp_err_level_error,
81 srtp_err_level_warning,
82 srtp_err_level_info,
83 srtp_err_level_debug
84} srtp_err_reporting_level_t;
85
86/*
87 * err_reporting_init prepares the error system. If
88 * ERR_REPORTING_STDOUT is defined, it will log to stdout.
89 *
90 */
91
92srtp_err_status_t srtp_err_reporting_init(void);
93
94typedef void(srtp_err_report_handler_func_t)(srtp_err_reporting_level_t level,
95 const char *msg);
96
97srtp_err_status_t srtp_install_err_report_handler(
98 srtp_err_report_handler_func_t func);
99
100/*
101 * srtp_err_report reports a 'printf' formatted error
102 * string, followed by a an arg list. The level argument
103 * is one of srtp_err_reporting_level_t.
104 *
105 * Errors will be reported to stdout, if ERR_REPORTING_STDOUT
106 * is defined.
107 *
108 */
109
110void srtp_err_report(srtp_err_reporting_level_t level, const char *format, ...)
111 LIBSRTP_FORMAT_PRINTF(2, 3);
112
113/*
114 * debug_module_t defines a debug module
115 */
116
117typedef struct {
118 int on; /* 1 if debugging is on, 0 if it is off */
119 const char *name; /* printable name for debug module */
121
122#ifdef ENABLE_DEBUG_LOGGING
123
124#define debug_print0(mod, format) \
125 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name)
126#define debug_print(mod, format, arg) \
127 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
128#define debug_print2(mod, format, arg1, arg2) \
129 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
130 arg1, arg2)
131
132#else
133
134#define debug_print0(mod, format) \
135 if (mod.on) \
136 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name)
137#define debug_print(mod, format, arg) \
138 if (mod.on) \
139 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
140#define debug_print2(mod, format, arg1, arg2) \
141 if (mod.on) \
142 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
143 arg1, arg2)
144
145#endif
146
147#ifdef __cplusplus
148}
149#endif
150
151#endif /* ERR_H */
srtp_err_status_t
srtp_err_status_t defines error codes.
Definition srtp.h:181
Definition err.h:117