4d581885dc998634c796c6c66b314a28a366182d
[asterisk/asterisk.git] / include / asterisk / features.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 Call Parking and Pickup API 
21  * Includes code and algorithms from the Zapata library.
22  */
23
24 #ifndef _AST_FEATURES_H
25 #define _AST_FEATURES_H
26
27 #include "asterisk/pbx.h"
28 #include "asterisk/linkedlists.h"
29
30 #define FEATURE_MAX_LEN         11
31 #define FEATURE_APP_LEN         64
32 #define FEATURE_APP_ARGS_LEN    256
33 #define FEATURE_SNAME_LEN       32
34 #define FEATURE_EXTEN_LEN       32
35 #define FEATURE_MOH_LEN         80  /* same as MAX_MUSICCLASS from channel.h */
36
37 #define PARK_APP_NAME "Park"
38
39 /*! \brief main call feature structure */
40
41 enum {
42         AST_FEATURE_FLAG_NEEDSDTMF = (1 << 0),
43         AST_FEATURE_FLAG_ONPEER =    (1 << 1),
44         AST_FEATURE_FLAG_ONSELF =    (1 << 2),
45         AST_FEATURE_FLAG_BYCALLEE =  (1 << 3),
46         AST_FEATURE_FLAG_BYCALLER =  (1 << 4),
47         AST_FEATURE_FLAG_BYBOTH  =   (3 << 3),
48 };
49
50 struct ast_call_feature {
51         int feature_mask;
52         char *fname;
53         char sname[FEATURE_SNAME_LEN];
54         char exten[FEATURE_MAX_LEN];
55         char default_exten[FEATURE_MAX_LEN];
56         int (*operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense, void *data);
57         unsigned int flags;
58         char app[FEATURE_APP_LEN];              
59         char app_args[FEATURE_APP_ARGS_LEN];
60         char moh_class[FEATURE_MOH_LEN];
61         AST_LIST_ENTRY(ast_call_feature) feature_entry;
62 };
63
64 #define AST_FEATURE_RETURN_HANGUP                   -1
65 #define AST_FEATURE_RETURN_SUCCESSBREAK             0
66 #define AST_FEATURE_RETURN_PASSDIGITS               21
67 #define AST_FEATURE_RETURN_STOREDIGITS              22
68 #define AST_FEATURE_RETURN_SUCCESS                  23
69 #define AST_FEATURE_RETURN_KEEPTRYING               24
70
71 /*!
72  * \brief Park a call and read back parked location 
73  * \param chan the channel to actually be parked
74  * \param host the channel which will have the parked location read to.
75  * \param timeout is a timeout in milliseconds
76  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
77  * 
78  * Park the channel chan, and read back the parked location to the host. 
79  * If the call is not picked up within a specified period of time, 
80  * then the call will return to the last step that it was in 
81  * (in terms of exten, priority and context)
82  * \retval 0 on success.
83  * \retval -1 on failure.
84 */
85 int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
86
87 /*! 
88  * \brief Park a call via a masqueraded channel
89  * \param rchan the real channel to be parked
90  * \param host the channel to have the parking read to.
91  * \param timeout is a timeout in milliseconds
92  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
93  * 
94  * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call
95  * \retval 0 on success.
96  * \retval -1 on failure.
97 */
98 int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
99
100 /*! 
101  * \brief Determine system parking extension
102  * \returns the call parking extension for drivers that provide special call parking help 
103 */
104 const char *ast_parking_ext(void);
105
106 /*! \brief Determine system call pickup extension */
107 const char *ast_pickup_ext(void);
108
109 /*! \brief Bridge a call, optionally allowing redirection */
110 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
111
112 /*! \brief Pickup a call */
113 int ast_pickup_call(struct ast_channel *chan);
114
115 /*! \brief register new feature into feature_set 
116    \param feature an ast_call_feature object which contains a keysequence
117    and a callback function which is called when this keysequence is pressed
118    during a call. */
119 void ast_register_feature(struct ast_call_feature *feature);
120
121 /*! \brief unregister feature from feature_set
122     \param feature the ast_call_feature object which was registered before*/
123 void ast_unregister_feature(struct ast_call_feature *feature);
124
125 /*! \brief look for a call feature entry by its sname
126         \param name a string ptr, should match "automon", "blindxfer", "atxfer", etc. */
127 struct ast_call_feature *ast_find_call_feature(const char *name);
128
129 void ast_rdlock_call_features(void);
130 void ast_unlock_call_features(void);
131
132 /*! \brief Reload call features from features.conf */
133 int ast_features_reload(void);
134
135 #endif /* _AST_FEATURES_H */