Thu Apr 28 2011 17:13:33

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 /*! \brief main call feature structure */
00040 
00041 enum {
00042    AST_FEATURE_FLAG_NEEDSDTMF = (1 << 0),
00043    AST_FEATURE_FLAG_ONPEER =    (1 << 1),
00044    AST_FEATURE_FLAG_ONSELF =    (1 << 2),
00045    AST_FEATURE_FLAG_BYCALLEE =  (1 << 3),
00046    AST_FEATURE_FLAG_BYCALLER =  (1 << 4),
00047    AST_FEATURE_FLAG_BYBOTH  =   (3 << 3),
00048 };
00049 
00050 struct ast_call_feature {
00051    int feature_mask;
00052    char *fname;
00053    char sname[FEATURE_SNAME_LEN];
00054    char exten[FEATURE_MAX_LEN];
00055    char default_exten[FEATURE_MAX_LEN];
00056    int (*operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense, void *data);
00057    unsigned int flags;
00058    char app[FEATURE_APP_LEN];    
00059    char app_args[FEATURE_APP_ARGS_LEN];
00060    char moh_class[FEATURE_MOH_LEN];
00061    AST_LIST_ENTRY(ast_call_feature) feature_entry;
00062 };
00063 
00064 #define AST_FEATURE_RETURN_HANGUP                   -1
00065 #define AST_FEATURE_RETURN_SUCCESSBREAK             0
00066 #define AST_FEATURE_RETURN_PASSDIGITS               21
00067 #define AST_FEATURE_RETURN_STOREDIGITS              22
00068 #define AST_FEATURE_RETURN_SUCCESS                  23
00069 #define AST_FEATURE_RETURN_KEEPTRYING               24
00070 #define AST_FEATURE_RETURN_PARKFAILED               25
00071 
00072 /*!
00073  * \brief Park a call and read back parked location 
00074  * \param chan the channel to actually be parked
00075  * \param host the channel which will have the parked location read to.
00076  * \param timeout is a timeout in milliseconds
00077  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00078  * 
00079  * Park the channel chan, and read back the parked location to the host. 
00080  * If the call is not picked up within a specified period of time, 
00081  * then the call will return to the last step that it was in 
00082  * (in terms of exten, priority and context)
00083  * \retval 0 on success.
00084  * \retval -1 on failure.
00085 */
00086 int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
00087 
00088 /*! 
00089  * \brief Park a call via a masqueraded channel
00090  * \param rchan the real channel to be parked
00091  * \param host the channel to have the parking read to.
00092  * \param timeout is a timeout in milliseconds
00093  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00094  * 
00095  * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call
00096  * \retval 0 on success.
00097  * \retval -1 on failure.
00098 */
00099 int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
00100 
00101 /*! 
00102  * \brief Determine system parking extension
00103  * \returns the call parking extension for drivers that provide special call parking help 
00104 */
00105 const char *ast_parking_ext(void);
00106 
00107 /*! \brief Determine system call pickup extension */
00108 const char *ast_pickup_ext(void);
00109 
00110 /*! \brief Bridge a call, optionally allowing redirection */
00111 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
00112 
00113 /*! \brief Pickup a call */
00114 int ast_pickup_call(struct ast_channel *chan);
00115 
00116 /*! \brief register new feature into feature_set 
00117    \param feature an ast_call_feature object which contains a keysequence
00118    and a callback function which is called when this keysequence is pressed
00119    during a call. */
00120 void ast_register_feature(struct ast_call_feature *feature);
00121 
00122 /*! \brief unregister feature from feature_set
00123     \param feature the ast_call_feature object which was registered before*/
00124 void ast_unregister_feature(struct ast_call_feature *feature);
00125 
00126 /*! \brief look for a call feature entry by its sname
00127    \param name a string ptr, should match "automon", "blindxfer", "atxfer", etc. */
00128 struct ast_call_feature *ast_find_call_feature(const char *name);
00129 
00130 void ast_rdlock_call_features(void);
00131 void ast_unlock_call_features(void);
00132 
00133 /*! \brief Reload call features from features.conf */
00134 int ast_features_reload(void);
00135 
00136 #endif /* _AST_FEATURES_H */