Add Flash() application XML documentation.
[asterisk/asterisk.git] / apps / app_flash.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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
19 /*! \file
20  *
21  * \brief App to flash a DAHDI trunk
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27  
28 /*** MODULEINFO
29         <depend>dahdi</depend>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include <dahdi/user.h>
37
38 #include "asterisk/lock.h"
39 #include "asterisk/file.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/translate.h"
44 #include "asterisk/image.h"
45
46 /*** DOCUMENTATION
47         <application name="Flash" language="en_US">
48                 <synopsis>
49                         Flashes a DAHDI Trunk.
50                 </synopsis>
51                 <syntax />
52                 <description>
53                         <para>Performs a flash on a DAHDI trunk. This can be used to access features
54                         provided on an incoming analogue circuit such as conference and call waiting.
55                         Use with SendDTMF() to perform external transfers.</para>
56                 </description>
57                 <see-also>
58                         <ref type="application">SendDTMF</ref>
59                 </see-also>
60         </application>
61  ***/
62
63 static char *app = "Flash";
64
65 static inline int dahdi_wait_event(int fd)
66 {
67         /* Avoid the silly dahdi_waitevent which ignores a bunch of events */
68         int i,j=0;
69         i = DAHDI_IOMUX_SIGEVENT;
70         if (ioctl(fd, DAHDI_IOMUX, &i) == -1) return -1;
71         if (ioctl(fd, DAHDI_GETEVENT, &j) == -1) return -1;
72         return j;
73 }
74
75 static int flash_exec(struct ast_channel *chan, void *data)
76 {
77         int res = -1;
78         int x;
79         struct dahdi_params dahdip;
80
81         if (strcasecmp(chan->tech->type, "DAHDI")) {
82                 ast_log(LOG_WARNING, "%s is not a DAHDI channel\n", chan->name);
83                 return -1;
84         }
85         
86         memset(&dahdip, 0, sizeof(dahdip));
87         res = ioctl(chan->fds[0], DAHDI_GET_PARAMS, &dahdip);
88         if (!res) {
89                 if (dahdip.sigtype & __DAHDI_SIG_FXS) {
90                         x = DAHDI_FLASH;
91                         res = ioctl(chan->fds[0], DAHDI_HOOK, &x);
92                         if (!res || (errno == EINPROGRESS)) {
93                                 if (res) {
94                                         /* Wait for the event to finish */
95                                         dahdi_wait_event(chan->fds[0]);
96                                 }
97                                 res = ast_safe_sleep(chan, 1000);
98                                 ast_verb(3, "Flashed channel %s\n", chan->name);
99                         } else
100                                 ast_log(LOG_WARNING, "Unable to flash channel %s: %s\n", chan->name, strerror(errno));
101                 } else
102                         ast_log(LOG_WARNING, "%s is not an FXO Channel\n", chan->name);
103         } else
104                 ast_log(LOG_WARNING, "Unable to get parameters of %s: %s\n", chan->name, strerror(errno));
105
106         return res;
107 }
108
109 static int unload_module(void)
110 {
111         return ast_unregister_application(app);
112 }
113
114 static int load_module(void)
115 {
116         return ast_register_application_xml(app, flash_exec);
117 }
118
119 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Flash channel application");
120