Files
asterisk/include/asterisk/syslog.h
Alexander Traud 57fef28dc9 progdocs: Avoid 'name' with Doxygen \file.
Fixes four misuses of the parameter 'name'. Additionally, for
consistency and to avoid such an issue in future, those few other
places, which used '\file name', were changed just to '\file'. Then,
Doxygen uses the name of the current file.

ASTERISK-29733

Change-Id: I0c18b4c863c6988b138c77448057349a9ee7052d
2021-11-18 08:17:56 -06:00

97 lines
2.4 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2009, malleable, LLC.
*
* Sean Bright <sean@malleable.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*!
* \file
*
* \brief Syslog support functions for Asterisk logging.
*/
#ifndef _ASTERISK_SYSLOG_H
#define _ASTERISK_SYSLOG_H
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
#define ASTNUMLOGLEVELS 32
/*!
* \since 1.8
* \brief Maps a syslog facility name from a string to a syslog facility
* constant.
*
* \param facility Facility name to map (i.e. "daemon")
*
* \retval syslog facility constant (i.e. LOG_DAEMON) if found
* \retval -1 if facility is not found
*/
int ast_syslog_facility(const char *facility);
/*!
* \since 1.8
* \brief Maps a syslog facility constant to a string.
*
* \param facility syslog facility constant to map (i.e. LOG_DAEMON)
*
* \retval facility name (i.e. "daemon") if found
* \retval NULL if facility is not found
*/
const char *ast_syslog_facility_name(int facility);
/*!
* \since 1.8
* \brief Maps a syslog priority name from a string to a syslog priority
* constant.
*
* \param priority Priority name to map (i.e. "notice")
*
* \retval syslog priority constant (i.e. LOG_NOTICE) if found
* \retval -1 if priority is not found
*/
int ast_syslog_priority(const char *priority);
/*!
* \since 1.8
* \brief Maps a syslog priority constant to a string.
*
* \param priority syslog priority constant to map (i.e. LOG_NOTICE)
*
* \retval priority name (i.e. "notice") if found
* \retval NULL if priority is not found
*/
const char *ast_syslog_priority_name(int priority);
/*!
* \since 1.8
* \brief Maps an Asterisk log level (i.e. LOG_ERROR) to a syslog priority
* constant.
*
* \param level Asterisk log level constant (i.e. LOG_ERROR)
*
* \retval syslog priority constant (i.e. LOG_ERR) if found
* \retval -1 if priority is not found
*/
int ast_syslog_priority_from_loglevel(int level);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* _ASTERISK_SYSLOG_H */