ca8ea8fc6556380c3588d0b7cc2540d666ff0a2e
[asterisk/asterisk.git] / include / asterisk / syslog.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, malleable, LLC.
5  *
6  * Sean Bright <sean@malleable.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file syslog.h
21  * \brief Syslog support functions for Asterisk logging.
22  */
23
24 #ifndef _ASTERISK_SYSLOG_H
25 #define _ASTERISK_SYSLOG_H
26
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30
31 /*!
32  * \since 1.6.3
33  * \brief Maps a syslog facility name from a string to a syslog facility
34  *        constant.
35  *
36  * \param facility Facility name to map (i.e. "daemon")
37  *
38  * \retval syslog facility constant (i.e. LOG_DAEMON) if found
39  * \retval -1 if facility is not found
40  */
41 int ast_syslog_facility(const char *facility);
42
43 /*!
44  * \since 1.6.3
45  * \brief Maps a syslog priority name from a string to a syslog priority
46  *        constant.
47  *
48  * \param priority Priority name to map (i.e. "notice")
49  *
50  * \retval syslog priority constant (i.e. LOG_NOTICE) if found
51  * \retval -1 if priority is not found
52  */
53 int ast_syslog_priority(const char *priority);
54
55 /*!
56  * \since 1.6.3
57  * \brief Maps an Asterisk log level (i.e. LOG_ERROR) to a syslog priority
58  *        constant.
59  *
60  * \param level Asterisk log level constant (i.e. LOG_ERROR)
61  *
62  * \retval syslog priority constant (i.e. LOG_ERR) if found
63  * \retval -1 if priority is not found
64  */
65 int ast_syslog_priority_from_loglevel(int level);
66
67 #if defined(__cplusplus) || defined(c_plusplus)
68 }
69 #endif
70
71 #endif /* _ASTERISK_SYSLOG_H */