Merged revisions 166093 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / features.h
old mode 100755 (executable)
new mode 100644 (file)
index 1e30f8a..4d58188
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Call Parking and Pickup API 
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  *
- * Mark Spencer <markster@linux-support.net>
+ * Mark Spencer <markster@digium.com>
  *
- * This program is free software, distributed under the terms of
- * the GNU General Public License.
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
  *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ * \brief Call Parking and Pickup API 
  * Includes code and algorithms from the Zapata library.
- *
  */
 
-#ifndef _PARKING_H
-#define _PARKING_H
-
-//! Park a call and read back parked location
-/*! \param chan the channel to actually be parked
-    \param host the channel which will have the parked location read to
-       Park the channel chan, and read back the parked location to the
-       host.  If the call is not picked up within a specified period of
-       time, then the call will return to the last step that it was in 
-       (in terms of exten, priority and context)
-       \param timeout is a timeout in milliseconds
-       \param extout is a parameter to an int that will hold the parked location, or NULL if you want
+#ifndef _AST_FEATURES_H
+#define _AST_FEATURES_H
+
+#include "asterisk/pbx.h"
+#include "asterisk/linkedlists.h"
+
+#define FEATURE_MAX_LEN                11
+#define FEATURE_APP_LEN                64
+#define FEATURE_APP_ARGS_LEN   256
+#define FEATURE_SNAME_LEN      32
+#define FEATURE_EXTEN_LEN      32
+#define FEATURE_MOH_LEN                80  /* same as MAX_MUSICCLASS from channel.h */
+
+#define PARK_APP_NAME "Park"
+
+/*! \brief main call feature structure */
+
+enum {
+       AST_FEATURE_FLAG_NEEDSDTMF = (1 << 0),
+       AST_FEATURE_FLAG_ONPEER =    (1 << 1),
+       AST_FEATURE_FLAG_ONSELF =    (1 << 2),
+       AST_FEATURE_FLAG_BYCALLEE =  (1 << 3),
+       AST_FEATURE_FLAG_BYCALLER =  (1 << 4),
+       AST_FEATURE_FLAG_BYBOTH  =   (3 << 3),
+};
+
+struct ast_call_feature {
+       int feature_mask;
+       char *fname;
+       char sname[FEATURE_SNAME_LEN];
+       char exten[FEATURE_MAX_LEN];
+       char default_exten[FEATURE_MAX_LEN];
+       int (*operation)(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, char *code, int sense, void *data);
+       unsigned int flags;
+       char app[FEATURE_APP_LEN];              
+       char app_args[FEATURE_APP_ARGS_LEN];
+       char moh_class[FEATURE_MOH_LEN];
+       AST_LIST_ENTRY(ast_call_feature) feature_entry;
+};
+
+#define AST_FEATURE_RETURN_HANGUP                   -1
+#define AST_FEATURE_RETURN_SUCCESSBREAK             0
+#define AST_FEATURE_RETURN_PASSDIGITS               21
+#define AST_FEATURE_RETURN_STOREDIGITS              22
+#define AST_FEATURE_RETURN_SUCCESS                  23
+#define AST_FEATURE_RETURN_KEEPTRYING               24
+
+/*!
+ * \brief Park a call and read back parked location 
+ * \param chan the channel to actually be parked
+ * \param host the channel which will have the parked location read to.
+ * \param timeout is a timeout in milliseconds
+ * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
+ * 
+ * Park the channel chan, and read back the parked location to the host. 
+ * If the call is not picked up within a specified period of time, 
+ * then the call will return to the last step that it was in 
+ * (in terms of exten, priority and context)
+ * \retval 0 on success.
+ * \retval -1 on failure.
 */
-extern int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
-//! Park a call via a masqueraded channel
-/*! \param rchan the real channel to be parked
-    \param host the channel to have the parking read to
-       Masquerade the channel rchan into a new, empty channel which is then
-       parked with ast_park_call
-       \param timeout is a timeout in milliseconds
-       \param extout is a parameter to an int that will hold the parked location, or NULL if you want
+int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
+
+/*! 
+ * \brief Park a call via a masqueraded channel
+ * \param rchan the real channel to be parked
+ * \param host the channel to have the parking read to.
+ * \param timeout is a timeout in milliseconds
+ * \param extout is a parameter to an int that will hold the parked location, or NULL if you want.
+ * 
+ * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call
+ * \retval 0 on success.
+ * \retval -1 on failure.
 */
-extern int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
+int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
+
+/*! 
+ * \brief Determine system parking extension
+ * \returns the call parking extension for drivers that provide special call parking help 
+*/
+const char *ast_parking_ext(void);
+
+/*! \brief Determine system call pickup extension */
+const char *ast_pickup_ext(void);
+
+/*! \brief Bridge a call, optionally allowing redirection */
+int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
+
+/*! \brief Pickup a call */
+int ast_pickup_call(struct ast_channel *chan);
 
-//! Determine system parking extension
-/*! Returns the call parking extension for drivers that provide special
-    call parking help */
-extern char *ast_parking_ext(void);
-extern char *ast_pickup_ext(void);
+/*! \brief register new feature into feature_set 
+   \param feature an ast_call_feature object which contains a keysequence
+   and a callback function which is called when this keysequence is pressed
+   during a call. */
+void ast_register_feature(struct ast_call_feature *feature);
 
-//! Bridge a call, optionally allowing redirection
+/*! \brief unregister feature from feature_set
+    \param feature the ast_call_feature object which was registered before*/
+void ast_unregister_feature(struct ast_call_feature *feature);
 
-extern int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
+/*! \brief look for a call feature entry by its sname
+       \param name a string ptr, should match "automon", "blindxfer", "atxfer", etc. */
+struct ast_call_feature *ast_find_call_feature(const char *name);
 
-extern int ast_pickup_call(struct ast_channel *chan);
+void ast_rdlock_call_features(void);
+void ast_unlock_call_features(void);
 
+/*! \brief Reload call features from features.conf */
+int ast_features_reload(void);
 
-#endif /* _PARKING_H */
+#endif /* _AST_FEATURES_H */