Sat Apr 26 2014 22:01:45

Asterisk developer's documentation


app_chanisavail.c File Reference

Check if Channel is Available. More...

#include "asterisk.h"
#include <sys/ioctl.h>
#include "asterisk/lock.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/devicestate.h"
Include dependency graph for app_chanisavail.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int chanavail_exec (struct ast_channel *chan, const char *data)
static int load_module (void)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Check channel availability" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static const char app [] = "ChanIsAvail"
static struct ast_module_infoast_module_info = &__mod_info

Detailed Description

Check if Channel is Available.

Author:
Mark Spencer <markster@digium.com>
James Golovich <james@gnuinter.net>

Definition in file app_chanisavail.c.


Function Documentation

static void __reg_module ( void  ) [static]

Definition at line 214 of file app_chanisavail.c.

static void __unreg_module ( void  ) [static]

Definition at line 214 of file app_chanisavail.c.

static int chanavail_exec ( struct ast_channel chan,
const char *  data 
) [static]

Definition at line 102 of file app_chanisavail.c.

References args, AST_APP_ARG, ast_channel_name(), ast_channel_nativeformats(), AST_DECLARE_APP_ARGS, AST_DEVICE_UNKNOWN, ast_hangup(), ast_log(), ast_parse_device_state(), ast_request(), AST_STANDARD_APP_ARGS, ast_str_alloca, ast_str_append(), ast_str_buffer(), ast_str_strlen(), ast_strlen_zero(), LOG_WARNING, pbx_builtin_setvar_helper(), peers, and status.

Referenced by load_module().

{
   int inuse=-1, option_state=0, string_compare=0, option_all_avail=0;
   int status;
   char *info, tmp[512], trychan[512], *peers, *tech, *number, *rest, *cur;
   struct ast_str *tmp_availchan = ast_str_alloca(2048);
   struct ast_str *tmp_availorig = ast_str_alloca(2048);
   struct ast_str *tmp_availstat = ast_str_alloca(2048);
   struct ast_str *tmp_availcause = ast_str_alloca(2048);
   struct ast_channel *tempchan;
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(reqchans);
      AST_APP_ARG(options);
   );

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "ChanIsAvail requires an argument (DAHDI/1&DAHDI/2)\n");
      return -1;
   }

   info = ast_strdupa(data);

   AST_STANDARD_APP_ARGS(args, info);

   if (args.options) {
      if (strchr(args.options, 'a')) {
         option_all_avail = 1;
      }
      if (strchr(args.options, 's')) {
         option_state = 1;
      }
      if (strchr(args.options, 't')) {
         string_compare = 1;
      }
   }
   peers = args.reqchans;
   if (peers) {
      cur = peers;
      do {
         /* remember where to start next time */
         rest = strchr(cur, '&');
         if (rest) {
            *rest = 0;
            rest++;
         }
         tech = cur;
         number = strchr(tech, '/');
         if (!number) {
            ast_log(LOG_WARNING, "ChanIsAvail argument takes format ([technology]/[device])\n");
            return -1;
         }
         *number = '\0';
         number++;

         status = AST_DEVICE_UNKNOWN;

         if (string_compare) {
            /* ast_parse_device_state checks for "SIP/1234" as a channel name.
               ast_device_state will ask the SIP driver for the channel state. */

            snprintf(trychan, sizeof(trychan), "%s/%s",cur,number);
            status = inuse = ast_parse_device_state(trychan);
         } else if (option_state) {
            /* If the pbx says in use then don't bother trying further.
               This is to permit testing if someone's on a call, even if the
               channel can permit more calls (ie callwaiting, sip calls, etc).  */

            snprintf(trychan, sizeof(trychan), "%s/%s",cur,number);
            status = inuse = ast_device_state(trychan);
         }
         snprintf(tmp, sizeof(tmp), "%d", status);
         ast_str_append(&tmp_availstat, 0, "%s%s", ast_str_strlen(tmp_availstat) ? "&" : "", tmp);
         if ((inuse <= 1) && (tempchan = ast_request(tech, ast_channel_nativeformats(chan), chan, number, &status))) {
               ast_str_append(&tmp_availchan, 0, "%s%s", ast_str_strlen(tmp_availchan) ? "&" : "", ast_channel_name(tempchan));
               
               snprintf(tmp, sizeof(tmp), "%s/%s", tech, number);
               ast_str_append(&tmp_availorig, 0, "%s%s", ast_str_strlen(tmp_availorig) ? "&" : "", tmp);

               snprintf(tmp, sizeof(tmp), "%d", status);
               ast_str_append(&tmp_availcause, 0, "%s%s", ast_str_strlen(tmp_availcause) ? "&" : "", tmp);

               ast_hangup(tempchan);
               tempchan = NULL;

               if (!option_all_avail) {
                  break;
               }
         }
         cur = rest;
      } while (cur);
   }

   pbx_builtin_setvar_helper(chan, "AVAILCHAN", ast_str_buffer(tmp_availchan));
   /* Store the originally used channel too */
   pbx_builtin_setvar_helper(chan, "AVAILORIGCHAN", ast_str_buffer(tmp_availorig));
   pbx_builtin_setvar_helper(chan, "AVAILSTATUS", ast_str_buffer(tmp_availstat));
   pbx_builtin_setvar_helper(chan, "AVAILCAUSECODE", ast_str_buffer(tmp_availcause));

   return 0;
}
static int unload_module ( void  ) [static]

Definition at line 203 of file app_chanisavail.c.

References ast_unregister_application().


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Check channel availability" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static]

Definition at line 214 of file app_chanisavail.c.

const char app[] = "ChanIsAvail" [static]

Definition at line 48 of file app_chanisavail.c.

Definition at line 214 of file app_chanisavail.c.