c92ab3c66546f92cf3f4ae4da2d9f8df56d5e0b7
[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 #include "asterisk/cli.h"
31
32 typedef struct agi_state {
33         int fd;                 /*!< FD for general output */
34         int audio;              /*!< FD for audio output */
35         int ctrl;               /*!< FD for input control */
36         unsigned int fast:1;    /*!< flag for fast agi or not */
37         struct ast_speech *speech; /*!< Speech structure for speech recognition */
38 } AGI;
39
40 typedef struct agi_command {
41         char *cmda[AST_MAX_CMD_LEN];            /*!< Null terminated list of the words of the command */
42         /*! Handler for the command (channel, AGI state, # of arguments, argument list). 
43             Returns RESULT_SHOWUSAGE for improper arguments */
44         int (*handler)(struct ast_channel *chan, AGI *agi, int argc, char *argv[]);
45         /*! Summary of the command (< 60 characters) */
46         char *summary;
47         /*! Detailed usage information */
48         char *usage;
49         /*! Does this application run dead */
50         int dead;
51         /*! AGI command syntax description */
52         char *syntax;
53         /*! See also content */
54         char *seealso;
55         /*! Where the documentation come from. */
56         enum ast_doc_src docsrc;
57         /*! Pointer to module that registered the agi command */
58         struct ast_module *mod;
59         /*! Linked list pointer */
60         AST_LIST_ENTRY(agi_command) list;
61 } agi_command;
62
63 #if defined(ASTERISK_AGI_OPTIONAL)
64 #define AGI_WEAK attribute_weak
65 #else
66 #define AGI_WEAK
67 #endif
68
69 /*!
70  * \brief
71  *
72  * Sends a string of text to an application connected via AGI.
73  *
74  * \param fd The file descriptor for the AGI session (from struct agi_state)
75  * \param chan Pointer to an associated Asterisk channel, if any
76  * \param fmt printf-style format string
77  * \return 0 for success, -1 for failure
78  *
79  */
80 int AGI_WEAK ast_agi_send(int fd, struct ast_channel *chan, char *fmt, ...) __attribute__((format(printf, 3, 4)));
81 int AGI_WEAK ast_agi_register(struct ast_module *mod, agi_command *cmd);
82 int AGI_WEAK ast_agi_unregister(struct ast_module *mod, agi_command *cmd);
83
84 /*!
85  * \brief
86  *
87  * Registers a group of AGI commands, provided as an array of struct agi_command
88  * entries.
89  *
90  * \param mod Pointer to the module_info structure for the module that is registering the commands
91  * \param cmd Pointer to the first entry in the array of commands
92  * \param len Length of the array (use the ARRAY_LEN macro to determine this easily)
93  * \return 0 on success, -1 on failure
94  *
95  * \note If any command fails to register, all commands previously registered during the operation
96  * will be unregistered. In other words, this function registers all the provided commands, or none
97  * of them.
98  */
99 int AGI_WEAK ast_agi_register_multiple(struct ast_module *mod, struct agi_command *cmd, unsigned int len);
100
101 /*!
102  * \brief
103  *
104  * Unregisters a group of AGI commands, provided as an array of struct agi_command
105  * entries.
106  *
107  * \param mod Pointer to the module_info structure for the module that is unregistering the commands
108  * \param cmd Pointer to the first entry in the array of commands
109  * \param len Length of the array (use the ARRAY_LEN macro to determine this easily)
110  * \return 0 on success, -1 on failure
111  *
112  * \note If any command fails to unregister, this function will continue to unregister the
113  * remaining commands in the array; it will not reregister the already-unregistered commands.
114  */
115 int AGI_WEAK ast_agi_unregister_multiple(struct ast_module *mod, struct agi_command *cmd, unsigned int len);
116
117 #if defined(__cplusplus) || defined(c_plusplus)
118 }
119 #endif
120
121 #endif /* _ASTERISK_AGI_H */