Wed Oct 28 11:51:03 2009

Asterisk developer's documentation


features.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief Call Parking and Pickup API 
00021  * Includes code and algorithms from the Zapata library.
00022  */
00023 
00024 #ifndef _AST_FEATURES_H
00025 #define _AST_FEATURES_H
00026 
00027 #include "asterisk/pbx.h"
00028 #include "asterisk/linkedlists.h"
00029 
00030 #define FEATURE_MAX_LEN    11
00031 #define FEATURE_APP_LEN    64
00032 #define FEATURE_APP_ARGS_LEN  256
00033 #define FEATURE_SNAME_LEN  32
00034 #define FEATURE_EXTEN_LEN  32
00035 #define FEATURE_MOH_LEN    80  /* same as MAX_MUSICCLASS from channel.h */
00036 
00037 #define PARK_APP_NAME "Park"
00038 
00039 #define AST_FEATURE_RETURN_HANGUP           -1
00040 #define AST_FEATURE_RETURN_SUCCESSBREAK     0
00041 #define AST_FEATURE_RETURN_PBX_KEEPALIVE    AST_PBX_KEEPALIVE
00042 #define AST_FEATURE_RETURN_NO_HANGUP_PEER   AST_PBX_NO_HANGUP_PEER
00043 #define AST_FEATURE_RETURN_PASSDIGITS       21
00044 #define AST_FEATURE_RETURN_STOREDIGITS      22
00045 #define AST_FEATURE_RETURN_SUCCESS          23
00046 #define AST_FEATURE_RETURN_KEEPTRYING       24
00047 #define AST_FEATURE_RETURN_PARKFAILED       25
00048 
00049 #define FEATURE_SENSE_CHAN (1 << 0)
00050 #define FEATURE_SENSE_PEER (1 << 1)
00051 
00052 typedef int (*ast_feature_operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense, void *data);
00053 
00054 /*! \brief main call feature structure */
00055 
00056 enum {
00057    AST_FEATURE_FLAG_NEEDSDTMF = (1 << 0),
00058    AST_FEATURE_FLAG_ONPEER =    (1 << 1),
00059    AST_FEATURE_FLAG_ONSELF =    (1 << 2),
00060    AST_FEATURE_FLAG_BYCALLEE =  (1 << 3),
00061    AST_FEATURE_FLAG_BYCALLER =  (1 << 4),
00062    AST_FEATURE_FLAG_BYBOTH  =   (3 << 3),
00063 };
00064 
00065 struct ast_call_feature {
00066    int feature_mask;
00067    char *fname;
00068    char sname[FEATURE_SNAME_LEN];
00069    char exten[FEATURE_MAX_LEN];
00070    char default_exten[FEATURE_MAX_LEN];
00071    ast_feature_operation operation;
00072    unsigned int flags;
00073    char app[FEATURE_APP_LEN];    
00074    char app_args[FEATURE_APP_ARGS_LEN];
00075    char moh_class[FEATURE_MOH_LEN];
00076    AST_LIST_ENTRY(ast_call_feature) feature_entry;
00077 };
00078 
00079 /*!
00080  * \brief Park a call and read back parked location 
00081  * \param chan the channel to actually be parked
00082  * \param host the channel which will have the parked location read to.
00083  * \param timeout is a timeout in milliseconds
00084  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00085  * 
00086  * Park the channel chan, and read back the parked location to the host. 
00087  * If the call is not picked up within a specified period of time, 
00088  * then the call will return to the last step that it was in 
00089  * (in terms of exten, priority and context)
00090  * \retval 0 on success.
00091  * \retval -1 on failure.
00092 */
00093 int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
00094 
00095 /*! 
00096  * \brief Park a call via a masqueraded channel
00097  * \param rchan the real channel to be parked
00098  * \param host the channel to have the parking read to.
00099  * \param timeout is a timeout in milliseconds
00100  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00101  * 
00102  * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call
00103  * \retval 0 on success.
00104  * \retval -1 on failure.
00105 */
00106 int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
00107 
00108 /*! 
00109  * \brief Determine system parking extension
00110  * \returns the call parking extension for drivers that provide special call parking help 
00111 */
00112 const char *ast_parking_ext(void);
00113 
00114 /*! \brief Determine system call pickup extension */
00115 const char *ast_pickup_ext(void);
00116 
00117 /*! \brief Bridge a call, optionally allowing redirection */
00118 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
00119 
00120 /*! \brief Pickup a call */
00121 int ast_pickup_call(struct ast_channel *chan);
00122 
00123 /*! \brief register new feature into feature_set 
00124    \param feature an ast_call_feature object which contains a keysequence
00125    and a callback function which is called when this keysequence is pressed
00126    during a call. */
00127 void ast_register_feature(struct ast_call_feature *feature);
00128 
00129 /*! \brief unregister feature from feature_set
00130     \param feature the ast_call_feature object which was registered before*/
00131 void ast_unregister_feature(struct ast_call_feature *feature);
00132 
00133 /*! \brief detect a feature before bridging 
00134     \param chan
00135     \param ast_flags ptr
00136     \param char ptr of input code
00137     \retval ast_call_feature ptr to be set if found 
00138     \return result, was feature found or not */
00139 int ast_feature_detect(struct ast_channel *chan, struct ast_flags *features, char *code, struct ast_call_feature *feature);
00140 
00141 /*! \brief look for a call feature entry by its sname
00142    \param name a string ptr, should match "automon", "blindxfer", "atxfer", etc. */
00143 struct ast_call_feature *ast_find_call_feature(const char *name);
00144 
00145 void ast_rdlock_call_features(void);
00146 void ast_unlock_call_features(void);
00147 
00148 /*! \brief Reload call features from features.conf */
00149 int ast_features_reload(void);
00150 
00151 #endif /* _AST_FEATURES_H */

Generated on Wed Oct 28 11:51:03 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6