Merge "BuildSystem: Really do not pass unknown-warning options to the compiler."
[asterisk/asterisk.git] / funcs / func_audiohookinherit.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.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  * Please follow coding guidelines
19  * http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES
20  */
21
22 /*! \file
23  *
24  * \brief Audiohook inheritance function
25  *
26  * \author Mark Michelson <mmichelson@digium.com>
27  *
28  * \ingroup functions
29  */
30
31 /*** MODULEINFO
32         <support_level>deprecated</support_level>
33  ***/
34
35 #include "asterisk.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/module.h"
40
41 /*** DOCUMENTATION
42         <function name = "AUDIOHOOK_INHERIT" language="en_US">
43                 <synopsis>
44                         DEPRECATED: Used to set whether an audiohook may be inherited to another
45                         channel. Due to architectural changes in Asterisk 12, audiohook inheritance
46                         is performed automatically and this function now lacks function.
47                 </synopsis>
48                 <description>
49                         <para>Prior to Asterisk 12, masquerades would occur under all sorts of
50                         situations which were hard to predict.  In Asterisk 12, masquerades only
51                         occur as a result of a small set of operations for which inheriting all
52                         audiohooks from the original channel is now safe.  So in Asterisk 12.5+,
53                         all audiohooks are inherited without needing other controls expressing
54                         which audiohooks should be inherited under which conditions.</para>
55                 </description>
56         </function>
57  ***/
58
59 static int func_inheritance_write(struct ast_channel *chan, const char *function, char *data, const char *value)
60 {
61         static int warned = 0;
62
63         if (!warned) {
64                 ast_log(LOG_NOTICE, "AUDIOHOOK_INHERIT is deprecated and now does nothing.\n");
65                 warned++;
66         }
67
68         return 0;
69 }
70
71 static struct ast_custom_function inheritance_function = {
72         .name = "AUDIOHOOK_INHERIT",
73         .write = func_inheritance_write,
74 };
75
76 static int unload_module(void)
77 {
78         return ast_custom_function_unregister(&inheritance_function);
79 }
80
81 static int load_module(void)
82 {
83         if (ast_custom_function_register(&inheritance_function)) {
84                 return AST_MODULE_LOAD_DECLINE;
85         } else {
86                 return AST_MODULE_LOAD_SUCCESS;
87         }
88 }
89 AST_MODULE_INFO_STANDARD_DEPRECATED(ASTERISK_GPL_KEY, "Audiohook inheritance placeholder function");