Mon May 14 04:42:55 2007

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 /*! \brief main call feature structure */
00035 struct ast_call_feature {
00036    int feature_mask;
00037    char *fname;
00038    char sname[FEATURE_SNAME_LEN];
00039    char exten[FEATURE_MAX_LEN];
00040    char default_exten[FEATURE_MAX_LEN];
00041    int (*operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense);
00042    unsigned int flags;
00043    char app[FEATURE_APP_LEN];    
00044    char app_args[FEATURE_APP_ARGS_LEN];
00045    char moh_class[FEATURE_MOH_LEN];
00046    AST_LIST_ENTRY(ast_call_feature) feature_entry;
00047 };
00048 
00049 
00050 
00051 /*! \brief Park a call and read back parked location 
00052  *  \param chan the channel to actually be parked
00053     \param host the channel which will have the parked location read to
00054    Park the channel chan, and read back the parked location to the
00055    host.  If the call is not picked up within a specified period of
00056    time, then the call will return to the last step that it was in 
00057    (in terms of exten, priority and context)
00058    \param timeout is a timeout in milliseconds
00059    \param extout is a parameter to an int that will hold the parked location, or NULL if you want
00060 */
00061 int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
00062 
00063 /*! \brief Park a call via a masqueraded channel
00064  *  \param rchan the real channel to be parked
00065     \param host the channel to have the parking read to
00066    Masquerade the channel rchan into a new, empty channel which is then
00067    parked with ast_park_call
00068    \param timeout is a timeout in milliseconds
00069    \param extout is a parameter to an int that will hold the parked location, or NULL if you want
00070 */
00071 int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
00072 
00073 /*! \brief Determine system parking extension
00074  *  Returns the call parking extension for drivers that provide special
00075     call parking help */
00076 char *ast_parking_ext(void);
00077 
00078 /*! \brief Determine system call pickup extension */
00079 char *ast_pickup_ext(void);
00080 
00081 /*! \brief Bridge a call, optionally allowing redirection */
00082 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
00083 
00084 /*! \brief Pickup a call */
00085 int ast_pickup_call(struct ast_channel *chan);
00086 
00087 /*! \brief register new feature into feature_set 
00088    \param feature an ast_call_feature object which contains a keysequence
00089    and a callback function which is called when this keysequence is pressed
00090    during a call. */
00091 void ast_register_feature(struct ast_call_feature *feature);
00092 
00093 /*! \brief unregister feature from feature_set
00094     \param feature the ast_call_feature object which was registered before*/
00095 void ast_unregister_feature(struct ast_call_feature *feature);
00096 
00097 #endif /* _AST_FEATURES_H */

Generated on Mon May 14 04:42:55 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1