Thu Apr 28 2011 17:15:15

Asterisk developer's documentation


app_softhangup.c

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  *
00021  * \brief SoftHangup application
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  * 
00025  * \ingroup applications
00026  */
00027 
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 229492 $")
00031 
00032 #include "asterisk/file.h"
00033 #include "asterisk/channel.h"
00034 #include "asterisk/pbx.h"
00035 #include "asterisk/module.h"
00036 #include "asterisk/lock.h"
00037 #include "asterisk/app.h"
00038 
00039 /*** DOCUMENTATION
00040    <application name="SoftHangup" language="en_US">
00041       <synopsis>
00042          Hangs up the requested channel.
00043       </synopsis>
00044       <syntax>
00045          <parameter name="Technology/Resource" required="true" />
00046          <parameter name="options">
00047             <optionlist>
00048                <option name="a">
00049                   <para>Hang up all channels on a specified device instead of a single resource</para>
00050                </option>
00051             </optionlist>
00052          </parameter>
00053       </syntax>   
00054       <description>
00055          <para>Hangs up the requested channel.  If there are no channels to 
00056          hangup, the application will report it.</para>
00057       </description>
00058    </application>
00059 
00060  ***/
00061 
00062 static char *app = "SoftHangup";
00063 
00064 enum {
00065    OPTION_ALL = (1 << 0),
00066 };
00067 
00068 AST_APP_OPTIONS(app_opts,{
00069    AST_APP_OPTION('a', OPTION_ALL),
00070 });
00071 
00072 static int softhangup_exec(struct ast_channel *chan, void *data)
00073 {
00074    struct ast_channel *c = NULL;
00075    char *cut, *opts[0];
00076    char name[AST_CHANNEL_NAME] = "", *parse;
00077    struct ast_flags flags = {0};
00078    int lenmatch;
00079    AST_DECLARE_APP_ARGS(args,
00080       AST_APP_ARG(channel);
00081       AST_APP_ARG(options);
00082    );
00083    
00084    if (ast_strlen_zero(data)) {
00085       ast_log(LOG_WARNING, "SoftHangup requires an argument (Technology/resource)\n");
00086       return 0;
00087    }
00088 
00089    parse = ast_strdupa(data);
00090    AST_STANDARD_APP_ARGS(args, parse);
00091 
00092    if (args.argc == 2)
00093       ast_app_parse_options(app_opts, &flags, opts, args.options);
00094    lenmatch = strlen(args.channel);
00095 
00096    for (c = ast_walk_channel_by_name_prefix_locked(NULL, args.channel, lenmatch);
00097        c;
00098        c = ast_walk_channel_by_name_prefix_locked(c, args.channel, lenmatch)) {
00099       ast_copy_string(name, c->name, sizeof(name));
00100       if (ast_test_flag(&flags, OPTION_ALL)) {
00101          /* CAPI is set up like CAPI[foo/bar]/clcnt */ 
00102          if (!strcmp(c->tech->type, "CAPI")) {
00103             cut = strrchr(name, '/');
00104          /* Basically everything else is Foo/Bar-Z */
00105          } else {
00106             /* use strrchr() because Foo/Bar-Z could actually be Foo/B-a-r-Z */
00107             cut = strrchr(name,'-');
00108          }
00109          /* Get rid of what we've cut */
00110          if (cut)
00111             *cut = 0;
00112       }
00113       if (!strcasecmp(name, args.channel)) {
00114          ast_log(LOG_WARNING, "Soft hanging %s up.\n", c->name);
00115          ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT);
00116          if (!ast_test_flag(&flags, OPTION_ALL)) {
00117             ast_channel_unlock(c);
00118             break;
00119          }
00120       }
00121       ast_channel_unlock(c);
00122    }
00123 
00124    return 0;
00125 }
00126 
00127 static int unload_module(void)
00128 {
00129    return ast_unregister_application(app);
00130 }
00131 
00132 static int load_module(void)
00133 {
00134    return ast_register_application_xml(app, softhangup_exec);
00135 }
00136 
00137 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Hangs up the requested channel");