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