4993be610a0466982110fa9e4e0ed6a31ee6906f
[asterisk/asterisk.git] / include / asterisk / res_pjproject.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2016, Fairview 5 Engineering, LLC
5  *
6  * George Joseph <george.joseph@fairview5.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 #ifndef _RES_PJPROJECT_H
20 #define _RES_PJPROJECT_H
21
22 /*!
23  * \brief Retrieve a pjproject build option
24  *
25  * \param option The build option requested
26  * \param format_string A scanf-style format string to parse the option value into
27  * \param ... Pointers to variables to receive the values parsed
28  *
29  * \retval The number of values parsed
30  *
31  * \since 13.8.0
32  *
33  * \note The option requested must be from those returned by pj_dump_config()
34  * which can be displayed with the 'pjsip show buildopts' CLI command.
35  *
36  *   <b>Sample Usage:</b>
37  *   \code
38  *
39  *   int max_hostname;
40  *
41  *   ast_sip_get_pjproject_buildopt("PJ_MAX_HOSTNAME", "%d", &max_hostname);
42  *
43  *   \endcode
44  *
45  */
46 int ast_pjproject_get_buildopt(char *option, char *format_string, ...) __attribute__((format(scanf, 2, 3)));
47
48 /*!
49  * \brief Begin PJPROJECT log interception for CLI output.
50  * \since 13.8.0
51  *
52  * \param fd CLI file descriptior to send intercepted output.
53  *
54  * \note ast_pjproject_log_intercept_begin() and
55  * ast_pjproject_log_intercept_end() must always be called
56  * in pairs.
57  *
58  * \return Nothing
59  */
60 void ast_pjproject_log_intercept_begin(int fd);
61
62 /*!
63  * \brief End PJPROJECT log interception for CLI output.
64  * \since 13.8.0
65  *
66  * \note ast_pjproject_log_intercept_begin() and
67  * ast_pjproject_log_intercept_end() must always be called
68  * in pairs.
69  *
70  * \return Nothing
71  */
72 void ast_pjproject_log_intercept_end(void);
73
74 #endif /* _RES_PJPROJECT_H */