1d86ac90bb0b04a0014c0b509811d67f1daf9b0e
[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         unsigned int fast:1; /* flag for fast agi or not */
35         struct ast_speech *speech; /* Speech structure for speech recognition */
36 } AGI;
37
38 typedef struct agi_command {
39         /* Null terminated list of the words of the command */
40         char *cmda[AST_MAX_CMD_LEN];
41         /* Handler for the command (channel, AGI state, # of arguments, argument list). 
42             Returns RESULT_SHOWUSAGE for improper arguments */
43         int (*handler)(struct ast_channel *chan, AGI *agi, int argc, char *argv[]);
44         /* Summary of the command (< 60 characters) */
45         char *summary;
46         /* Detailed usage information */
47         char *usage;
48         /* Does this application run dead */
49         int dead;
50         /* Pointer to module that registered the agi command */
51         struct ast_module *mod;
52         /* Linked list pointer */
53         AST_LIST_ENTRY(agi_command) list;
54 } agi_command;
55
56 int ast_agi_fdprintf(struct ast_channel *chan, int fd, char *fmt, ...);
57 int ast_agi_register(struct ast_module *mod, agi_command *cmd);
58 int ast_agi_unregister(struct ast_module *mod, agi_command *cmd);
59 void ast_agi_register_multiple(struct ast_module *mod, agi_command *cmd, int len);
60 void ast_agi_unregister_multiple(struct ast_module *mod, agi_command *cmd, int len);
61
62 #if defined(__cplusplus) || defined(c_plusplus)
63 }
64 #endif
65
66 #endif /* _ASTERISK_AGI_H */