Thu Jul 9 13:40:34 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 #define FEATURE_MAX_LEN    11
00028 #define FEATURE_APP_LEN    64
00029 #define FEATURE_APP_ARGS_LEN  256
00030 #define FEATURE_SNAME_LEN  32
00031 #define FEATURE_EXTEN_LEN  32
00032 #define FEATURE_MOH_LEN    80  /* same as MAX_MUSICCLASS from channel.h */
00033 
00034 #define AST_FEATURE_RETURN_HANGUP           -1
00035 #define AST_FEATURE_RETURN_SUCCESSBREAK     0
00036 #define AST_FEATURE_RETURN_PBX_KEEPALIVE    AST_PBX_KEEPALIVE
00037 #define AST_FEATURE_RETURN_NO_HANGUP_PEER   AST_PBX_NO_HANGUP_PEER
00038 #define AST_FEATURE_RETURN_PASSDIGITS       21
00039 #define AST_FEATURE_RETURN_STOREDIGITS      22
00040 #define AST_FEATURE_RETURN_SUCCESS          23
00041 #define AST_FEATURE_RETURN_KEEPTRYING       24
00042 #define AST_FEATURE_RETURN_PARKFAILED       25
00043 
00044 #define FEATURE_SENSE_CHAN (1 << 0)
00045 #define FEATURE_SENSE_PEER (1 << 1)
00046 
00047 typedef int (*ast_feature_operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense, void *data);
00048 
00049 /*! \brief main call feature structure */
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    ast_feature_operation operation;
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 
00065 /*!
00066  * \brief Park a call and read back parked location 
00067  * \param chan the channel to actually be parked
00068  * \param host the channel which will have the parked location read to.
00069  * \param timeout is a timeout in milliseconds
00070  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00071  * 
00072  * Park the channel chan, and read back the parked location to the host. 
00073  * If the call is not picked up within a specified period of time, 
00074  * then the call will return to the last step that it was in 
00075  * (in terms of exten, priority and context)
00076  * \retval 0 on success.
00077  * \retval -1 on failure.
00078 */
00079 int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
00080 
00081 /*! 
00082  * \brief Park a call via a masqueraded channel
00083  * \param rchan the real channel to be parked
00084  * \param host the channel to have the parking read to.
00085  * \param timeout is a timeout in milliseconds
00086  * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
00087  * 
00088  * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call
00089  * \retval 0 on success.
00090  * \retval -1 on failure.
00091 */
00092 int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
00093 
00094 /*! 
00095  * \brief Determine system parking extension
00096  * \returns the call parking extension for drivers that provide special call parking help 
00097 */
00098 const char *ast_parking_ext(void);
00099 
00100 /*! \brief Determine system call pickup extension */
00101 const char *ast_pickup_ext(void);
00102 
00103 /*! \brief Bridge a call, optionally allowing redirection */
00104 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
00105 
00106 /*! \brief Pickup a call */
00107 int ast_pickup_call(struct ast_channel *chan);
00108 
00109 /*! \brief register new feature into feature_set 
00110    \param feature an ast_call_feature object which contains a keysequence
00111    and a callback function which is called when this keysequence is pressed
00112    during a call. */
00113 void ast_register_feature(struct ast_call_feature *feature);
00114 
00115 /*! \brief unregister feature from feature_set
00116     \param feature the ast_call_feature object which was registered before*/
00117 void ast_unregister_feature(struct ast_call_feature *feature);
00118 
00119 /*! \brief detect a feature before bridging 
00120     \param chan
00121     \param ast_flags ptr
00122     \param char ptr of input code
00123     \retval ast_call_feature ptr to be set if found 
00124     \return result, was feature found or not */
00125 int ast_feature_detect(struct ast_channel *chan, struct ast_flags *features, char *code, struct ast_call_feature *feature);
00126 
00127 /*! \brief look for a call feature entry by its sname
00128    \param name a string ptr, should match "automon", "blindxfer", "atxfer", etc. */
00129 struct ast_call_feature *ast_find_call_feature(const char *name);
00130 
00131 void ast_rdlock_call_features(void);
00132 void ast_unlock_call_features(void);
00133 
00134 /*! \brief Reload call features from features.conf */
00135 int ast_features_reload(void);
00136 
00137 #endif /* _AST_FEATURES_H */

Generated on Thu Jul 9 13:40:34 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7