Move origination to use the dialing API and send Stasis messages on dial begin and...
[asterisk/asterisk.git] / include / asterisk / dial.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2007, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 Dialing API
21  */
22
23 #ifndef _ASTERISK_DIAL_H
24 #define _ASTERISK_DIAL_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 /*! \brief Main dialing structure. Contains global options, channels being dialed, and more! */
31 struct ast_dial;
32
33 /*! \brief Dialing channel structure. Contains per-channel dialing options, asterisk channel, and more! */
34 struct ast_dial_channel;
35
36 /*! \brief Forward declaration for format capabilities, used in prerun */
37 struct ast_format_cap;
38
39 typedef void (*ast_dial_state_callback)(struct ast_dial *);
40
41 /*! \brief List of options that are applicable either globally or per dialed channel */
42 enum ast_dial_option {
43         AST_DIAL_OPTION_RINGING,                 /*!< Always indicate ringing to caller */
44         AST_DIAL_OPTION_ANSWER_EXEC,             /*!< Execute application upon answer in async mode */
45         AST_DIAL_OPTION_MUSIC,                   /*!< Play music on hold instead of ringing to the calling channel */
46         AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, /*!< Disable call forwarding on channels */
47         AST_DIAL_OPTION_MAX,                     /*!< End terminator -- must always remain last */
48 };
49
50 /*! \brief List of return codes for dial run API calls */
51 enum ast_dial_result {
52         AST_DIAL_RESULT_INVALID,     /*!< Invalid options were passed to run function */
53         AST_DIAL_RESULT_FAILED,      /*!< Attempts to dial failed before reaching critical state */
54         AST_DIAL_RESULT_TRYING,      /*!< Currently trying to dial */
55         AST_DIAL_RESULT_RINGING,     /*!< Dial is presently ringing */
56         AST_DIAL_RESULT_PROGRESS,    /*!< Dial is presently progressing */
57         AST_DIAL_RESULT_PROCEEDING,  /*!< Dial is presently proceeding */
58         AST_DIAL_RESULT_ANSWERED,    /*!< A channel was answered */
59         AST_DIAL_RESULT_TIMEOUT,     /*!< Timeout was tripped, nobody answered */
60         AST_DIAL_RESULT_HANGUP,      /*!< Caller hung up */
61         AST_DIAL_RESULT_UNANSWERED,  /*!< Nobody answered */
62 };
63
64 /*! \brief New dialing structure
65  * \note Create a dialing structure
66  * \return Returns a calloc'd ast_dial structure, NULL on failure
67  */
68 struct ast_dial *ast_dial_create(void);
69
70 /*! \brief Append a channel
71  * \note Appends a channel to a dialing structure
72  * \return Returns channel reference number on success, -1 on failure
73  */
74 int ast_dial_append(struct ast_dial *dial, const char *tech, const char *device);
75
76 /*! \brief Request all appended channels, but do not dial
77  * \param dial Dialing structure
78  * \param chan Optional dialing channel
79  * \param cap Optional requested capabilities
80  * \retval -1 failure
81  * \reval 0 success
82  */
83 int ast_dial_prerun(struct ast_dial *dial, struct ast_channel *chan, struct ast_format_cap *cap);
84
85 /*! \brief Execute dialing synchronously or asynchronously
86  * \note Dials channels in a dial structure.
87  * \return Returns dial result code. (TRYING/INVALID/FAILED/ANSWERED/TIMEOUT/UNANSWERED).
88  */
89 enum ast_dial_result ast_dial_run(struct ast_dial *dial, struct ast_channel *chan, int async);
90
91 /*! \brief Return channel that answered
92  * \note Returns the Asterisk channel that answered
93  * \param dial Dialing structure
94  */
95 struct ast_channel *ast_dial_answered(struct ast_dial *dial);
96
97 /*! \brief Steal the channel that answered
98  * \note Returns the Asterisk channel that answered and removes it from the dialing structure
99  * \param dial Dialing structure
100  */
101 struct ast_channel *ast_dial_answered_steal(struct ast_dial *dial);
102
103 /*! \brief Return state of dial
104  * \note Returns the state of the dial attempt
105  * \param dial Dialing structure
106  */
107 enum ast_dial_result ast_dial_state(struct ast_dial *dial);
108
109 /*! \brief Cancel async thread
110  * \note Cancel a running async thread
111  * \param dial Dialing structure
112  */
113 enum ast_dial_result ast_dial_join(struct ast_dial *dial);
114
115 /*! \brief Hangup channels
116  * \note Hangup all active channels
117  * \param dial Dialing structure
118  */
119 void ast_dial_hangup(struct ast_dial *dial);
120
121 /*! \brief Destroys a dialing structure
122  * \note Cancels dialing and destroys (free's) the given ast_dial structure
123  * \param dial Dialing structure to free
124  * \return Returns 0 on success, -1 on failure
125  */
126 int ast_dial_destroy(struct ast_dial *dial);
127
128 /*! \brief Enables an option globally
129  * \param dial Dial structure to enable option on
130  * \param option Option to enable
131  * \param data Data to pass to this option (not always needed)
132  * \return Returns 0 on success, -1 on failure
133  */
134 int ast_dial_option_global_enable(struct ast_dial *dial, enum ast_dial_option option, void *data);
135
136 /*! \brief Enables an option per channel
137  * \param dial Dial structure
138  * \param num Channel number to enable option on
139  * \param option Option to enable
140  * \param data Data to pass to this option (not always needed)
141  * \return Returns 0 on success, -1 on failure
142  */
143 int ast_dial_option_enable(struct ast_dial *dial, int num, enum ast_dial_option option, void *data);
144
145 /*! \brief Disables an option globally
146  * \param dial Dial structure to disable option on
147  * \param option Option to disable
148  * \return Returns 0 on success, -1 on failure
149  */
150 int ast_dial_option_global_disable(struct ast_dial *dial, enum ast_dial_option option);
151
152 /*! \brief Disables an option per channel
153  * \param dial Dial structure
154  * \param num Channel number to disable option on
155  * \param option Option to disable
156  * \return Returns 0 on success, -1 on failure
157  */
158 int ast_dial_option_disable(struct ast_dial *dial, int num, enum ast_dial_option option);
159
160 /*! \brief Get the reason an outgoing channel has failed
161  * \param dial Dial structure
162  * \param num Channel number to get the reason from
163  * \return Numerical cause code
164  */
165 int ast_dial_reason(struct ast_dial *dial, int num);
166
167 /*! \brief Get the dialing channel, if prerun has been executed
168  * \param dial Dial structure
169  * \param num Channel number to get channel of
170  * \return Pointer to channel, without reference
171  */
172 struct ast_channel *ast_dial_get_channel(struct ast_dial *dial, int num);
173
174 /*! \brief Set a callback for state changes
175  * \param dial The dial structure to watch for state changes
176  * \param callback the callback
177  * \return nothing
178  */
179 void ast_dial_set_state_callback(struct ast_dial *dial, ast_dial_state_callback callback);
180
181 /*! \brief Set user data on a dial structure
182  * \param dial The dial structure to set a user data pointer on
183  * \param user_data The user data pointer
184  * \return nothing
185  */
186 void ast_dial_set_user_data(struct ast_dial *dial, void *user_data);
187
188 /*! \brief Return the user data on a dial structure
189  * \param dial The dial structure
190  * \return A pointer to the user data
191  */
192 void *ast_dial_get_user_data(struct ast_dial *dial);
193
194 /*! \brief Set the maximum time (globally) allowed for trying to ring phones
195  * \param dial The dial structure to apply the time limit to
196  * \param timeout Maximum time allowed in milliseconds
197  * \return nothing
198  */
199 void ast_dial_set_global_timeout(struct ast_dial *dial, int timeout);
200
201 /*! \brief Set the maximum time (per channel) allowed for trying to ring the phone
202  * \param dial The dial structure the channel belongs to
203  * \param num Channel number to set timeout on
204  * \param timeout Maximum time allowed in milliseconds
205  * \return nothing
206  */
207 void ast_dial_set_timeout(struct ast_dial *dial, int num, int timeout);
208
209 #if defined(__cplusplus) || defined(c_plusplus)
210 }
211 #endif
212
213 #endif /* _ASTERISK_DIAL_H */