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 53 extern "C" { 54 #endif 55 56 /** 57 * @defgroup Error Error Codes 58 * 59 * Error status codes are represented by the enumeration srtp_err_status_t. 60 * 61 * @{ 62 */ 63 64 /** 65 * @} 66 */ 67 68 typedef 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 81 srtp_err_status_t srtp_err_reporting_init(void); 82 83 typedef void(srtp_err_report_handler_func_t)(srtp_err_reporting_level_t level, 84 const char *msg); 85 86 srtp_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 99 void srtp_err_report(srtp_err_reporting_level_t level, const char *format, ...); 100 101 /* 102 * debug_module_t defines a debug module 103 */ 104 105 typedef struct { 106 int on; /* 1 if debugging is on, 0 if it is off */ 107 const char *name; /* printable name for debug module */ 108 } srtp_debug_module_t; 109 110 #ifdef ENABLE_DEBUG_LOGGING 111 112 #define debug_print(mod, format, arg) \ 113 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg) 114 #define debug_print2(mod, format, arg1, arg2) \ 115 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \ 116 arg1, arg2) 117 118 #else 119 120 #define debug_print(mod, format, arg) \ 121 if (mod.on) \ 122 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg) 123 #define debug_print2(mod, format, arg1, arg2) \ 124 if (mod.on) \ 125 srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \ 126 arg1, arg2) 127 128 #endif 129 130 #ifdef __cplusplus 131 } 132 #endif 133 134 #endif /* ERR_H */ 135