135 lines
3.9 KiB
C
135 lines
3.9 KiB
C
|
/*
|
||
|
|
* err.h
|
||
|
|
*
|
||
|
|
* error status codes
|
||
|
|
*
|
||
|
|
* David A. McGrew
|
||
|
|
* Cisco Systems, Inc.
|
||
|
|
*/
|
||
|
|
/*
|
||
|
|
*
|
||
|
|
* Copyright (c) 2001-2017, Cisco Systems, Inc.
|
||
|
|
* All rights reserved.
|
||
|
|
*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions
|
||
|
|
* are met:
|
||
|
|
*
|
||
|
|
* Redistributions of source code must retain the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer.
|
||
|
|
*
|
||
|
|
* Redistributions in binary form must reproduce the above
|
||
|
|
* copyright notice, this list of conditions and the following
|
||
|
|
* disclaimer in the documentation and/or other materials provided
|
||
|
|
* with the distribution.
|
||
|
|
*
|
||
|
|
* Neither the name of the Cisco Systems, Inc. nor the names of its
|
||
|
|
* contributors may be used to endorse or promote products derived
|
||
|
|
* from this software without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||
|
|
* COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
||
|
|
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
||
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef ERR_H
|
||
|
|
#define ERR_H
|
||
|
|
|
||
|
|
#include <stdio.h>
|
||
|
|
#include <stdarg.h>
|
||
|
|
#include "srtp.h"
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @defgroup Error Error Codes
|
||
|
|
*
|
||
|
|
* Error status codes are represented by the enumeration srtp_err_status_t.
|
||
|
|
*
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
typedef enum {
|
||
|
|
srtp_err_level_error,
|
||
|
|
srtp_err_level_warning,
|
||
|
|
srtp_err_level_info,
|
||
|
|
srtp_err_level_debug
|
||
|
|
} srtp_err_reporting_level_t;
|
||
|
|
|
||
|
|
/*
|
||
|
|
* err_reporting_init prepares the error system. If
|
||
|
|
* ERR_REPORTING_STDOUT is defined, it will log to stdout.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
srtp_err_status_t srtp_err_reporting_init(void);
|
||
|
|
|
||
|
|
typedef void(srtp_err_report_handler_func_t)(srtp_err_reporting_level_t level,
|
||
|
|
const char *msg);
|
||
|
|
|
||
|
|
srtp_err_status_t srtp_install_err_report_handler(
|
||
|
|
srtp_err_report_handler_func_t func);
|
||
|
|
|
||
|
|
/*
|
||
|
|
* srtp_err_report reports a 'printf' formatted error
|
||
|
|
* string, followed by a an arg list. The level argument
|
||
|
|
* is one of srtp_err_reporting_level_t.
|
||
|
|
*
|
||
|
|
* Errors will be reported to stdout, if ERR_REPORTING_STDOUT
|
||
|
|
* is defined.
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
void srtp_err_report(srtp_err_reporting_level_t level, const char *format, ...);
|
||
|
|
|
||
|
|
/*
|
||
|
|
* debug_module_t defines a debug module
|
||
|
|
*/
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
int on; /* 1 if debugging is on, 0 if it is off */
|
||
|
|
const char *name; /* printable name for debug module */
|
||
|
|
} srtp_debug_module_t;
|
||
|
|
|
||
|
|
#ifdef ENABLE_DEBUG_LOGGING
|
||
|
|
|
||
|
|
#define debug_print(mod, format, arg) \
|
||
|
|
srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
|
||
|
|
#define debug_print2(mod, format, arg1, arg2) \
|
||
|
|
srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
|
||
|
|
arg1, arg2)
|
||
|
|
|
||
|
|
#else
|
||
|
|
|
||
|
|
#define debug_print(mod, format, arg) \
|
||
|
|
if (mod.on) \
|
||
|
|
srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, arg)
|
||
|
|
#define debug_print2(mod, format, arg1, arg2) \
|
||
|
|
if (mod.on) \
|
||
|
|
srtp_err_report(srtp_err_level_debug, ("%s: " format "\n"), mod.name, \
|
||
|
|
arg1, arg2)
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* ERR_H */
|