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

Generated on Tue Apr 28 22:50:07 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7