Enhance AGI with several fixes:
[asterisk/asterisk.git] / include / asterisk / agi.h
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  * \brief AGI Extension interfaces - Asterisk Gateway Interface
21  */
22
23 #ifndef _ASTERISK_AGI_H
24 #define _ASTERISK_AGI_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 typedef struct agi_state {
31         int fd;         /* FD for general output */
32         int audio;      /* FD for audio output */
33         int ctrl;       /* FD for input control */
34 } AGI;
35
36 typedef struct agi_command {
37         /* Null terminated list of the words of the command */
38         char *cmda[AST_MAX_CMD_LEN];
39         /* Handler for the command (channel, AGI state, # of arguments, argument list). 
40             Returns RESULT_SHOWUSAGE for improper arguments */
41         int (*handler)(struct ast_channel *chan, AGI *agi, int argc, char *argv[]);
42         /* Summary of the command (< 60 characters) */
43         char *summary;
44         /* Detailed usage information */
45         char *usage;
46         /* Does this application run dead */
47         int dead;
48         /* Linked list pointer */
49         AST_LIST_ENTRY(agi_command) list;
50 } agi_command;
51
52 int ast_agi_register(agi_command *cmd);
53 int ast_agi_unregister(agi_command *cmd);
54
55 #if defined(__cplusplus) || defined(c_plusplus)
56 }
57 #endif
58
59 #endif /* _ASTERISK_AGI_H */