Wed Oct 28 11:53:04 2009

Asterisk developer's documentation


res_clioriginate.c File Reference

Originate calls via the CLI. More...

#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"
#include "asterisk/frame.h"

Include dependency graph for res_clioriginate.c:

Go to the source code of this file.

Defines

#define TIMEOUT   30

Functions

static void __reg_module (void)
static void __unreg_module (void)
 ASTERISK_FILE_VERSION (__FILE__,"$Revision: 102379 $")
static char * handle_orig (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 handle for orgination app or exten.
static int load_module (void)
 Load orginate module.
static char * orig_app (int fd, const char *chan, const char *app, const char *appdata)
 orginate a call from the CLI
static char * orig_exten (int fd, const char *chan, const char *data)
 orginate from extension
static int unload_module (void)
 Unload orginate module.

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Call origination from the CLI" , .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, }
static struct ast_module_infoast_module_info = &__mod_info
static struct ast_cli_entry cli_cliorig []


Detailed Description

Originate calls via the CLI.

Author:
Russell Bryant <russell@digium.com>

Definition in file res_clioriginate.c.


Define Documentation

#define TIMEOUT   30

The timeout for originated calls, in seconds

Definition at line 39 of file res_clioriginate.c.

Referenced by orig_app(), orig_exten(), rpt(), and rpt_tele_thread().


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 191 of file res_clioriginate.c.

static void __unreg_module ( void   )  [static]

Definition at line 191 of file res_clioriginate.c.

ASTERISK_FILE_VERSION ( __FILE__  ,
"$Revision: 102379 $"   
)

static char* handle_orig ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
) [static]

handle for orgination app or exten.

Parameters:
e pointer to the CLI structure to initialize
cmd operation to execute
a structure that contains either application or extension arguments
Return values:
CLI_SUCCESS on success.
CLI_SHOWUSAGE on failure.

Definition at line 119 of file res_clioriginate.c.

References ast_cli_args::argv, ast_cli_complete(), ast_module_ref(), ast_module_unref(), ast_strlen_zero(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, ast_cli_args::fd, ast_cli_args::n, orig_app(), orig_exten(), ast_cli_args::pos, ast_cli_entry::usage, and ast_cli_args::word.

00120 {
00121    static char *choices[] = { "application", "extension", NULL };
00122    char *res;
00123    switch (cmd) {
00124    case CLI_INIT:
00125       e->command = "originate";
00126       e->usage = 
00127          "  There are two ways to use this command. A call can be originated between a\n"
00128          "channel and a specific application, or between a channel and an extension in\n"
00129          "the dialplan. This is similar to call files or the manager originate action.\n"
00130          "Calls originated with this command are given a timeout of 30 seconds.\n\n"
00131 
00132          "Usage1: originate <tech/data> application <appname> [appdata]\n"
00133          "  This will originate a call between the specified channel tech/data and the\n"
00134          "given application. Arguments to the application are optional. If the given\n"
00135          "arguments to the application include spaces, all of the arguments to the\n"
00136          "application need to be placed in quotation marks.\n\n"
00137 
00138          "Usage2: originate <tech/data> extension [exten@][context]\n"
00139          "  This will originate a call between the specified channel tech/data and the\n"
00140          "given extension. If no context is specified, the 'default' context will be\n"
00141          "used. If no extension is given, the 's' extension will be used.\n";
00142       return NULL;
00143    case CLI_GENERATE:
00144       if (a->pos != 2)
00145          return NULL;
00146 
00147       /* ugly, can be removed when CLI entries have ast_module pointers */
00148       ast_module_ref(ast_module_info->self);
00149       res = ast_cli_complete(a->word, choices, a->n);
00150       ast_module_unref(ast_module_info->self);
00151 
00152       return res;
00153    }
00154 
00155    if (ast_strlen_zero(a->argv[1]) || ast_strlen_zero(a->argv[2]))
00156       return CLI_SHOWUSAGE;
00157 
00158    /* ugly, can be removed when CLI entries have ast_module pointers */
00159    ast_module_ref(ast_module_info->self);
00160 
00161    if (!strcasecmp("application", a->argv[2])) {
00162       res = orig_app(a->fd, a->argv[1], a->argv[3], a->argv[4]);  
00163    } else if (!strcasecmp("extension", a->argv[2])) {
00164       res = orig_exten(a->fd, a->argv[1], a->argv[3]);
00165    } else
00166       res = CLI_SHOWUSAGE;
00167 
00168    ast_module_unref(ast_module_info->self);
00169 
00170    return res;
00171 }

static int load_module ( void   )  [static]

Load orginate module.

Definition at line 184 of file res_clioriginate.c.

References ARRAY_LEN, ast_cli_register_multiple(), AST_MODULE_LOAD_DECLINE, and AST_MODULE_LOAD_SUCCESS.

00185 {
00186    int res;
00187    res = ast_cli_register_multiple(cli_cliorig, ARRAY_LEN(cli_cliorig));
00188    return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
00189 }

static char* orig_app ( int  fd,
const char *  chan,
const char *  app,
const char *  appdata 
) [static]

orginate a call from the CLI

Parameters:
fd file descriptor for cli
chan channel to create type/data
app application you want to run
appdata data for application
Return values:
CLI_SUCCESS on success.
CLI_SHOWUSAGE on failure.

Definition at line 50 of file res_clioriginate.c.

References ast_cli(), AST_FORMAT_SLINEAR, ast_pbx_outgoing_app(), ast_strdupa, ast_strlen_zero(), CLI_SHOWUSAGE, CLI_SUCCESS, strsep(), and TIMEOUT.

Referenced by handle_orig().

00051 {
00052    char *chantech;
00053    char *chandata;
00054    int reason = 0;
00055    
00056    if (ast_strlen_zero(app))
00057       return CLI_SHOWUSAGE;
00058 
00059    chandata = ast_strdupa(chan);
00060    
00061    chantech = strsep(&chandata, "/");
00062    if (!chandata) {
00063       ast_cli(fd, "*** No data provided after channel type! ***\n");
00064       return CLI_SHOWUSAGE;
00065    }
00066 
00067    ast_pbx_outgoing_app(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, app, appdata, &reason, 0, NULL, NULL, NULL, NULL, NULL);
00068 
00069    return CLI_SUCCESS;
00070 }

static char* orig_exten ( int  fd,
const char *  chan,
const char *  data 
) [static]

orginate from extension

Parameters:
fd file descriptor for cli
chan channel to create type/data
data contains exten@context
Return values:
CLI_SUCCESS on success.
CLI_SHOWUSAGE on failure.

Definition at line 80 of file res_clioriginate.c.

References ast_cli(), AST_FORMAT_SLINEAR, ast_pbx_outgoing_exten(), ast_strdupa, ast_strlen_zero(), CLI_SHOWUSAGE, CLI_SUCCESS, context, exten, strsep(), and TIMEOUT.

Referenced by handle_orig(), and park_call_exec().

00081 {
00082    char *chantech;
00083    char *chandata;
00084    char *exten = NULL;
00085    char *context = NULL;
00086    int reason = 0;
00087 
00088    chandata = ast_strdupa(chan);
00089    
00090    chantech = strsep(&chandata, "/");
00091    if (!chandata) {
00092       ast_cli(fd, "*** No data provided after channel type! ***\n");
00093       return CLI_SHOWUSAGE;
00094    }
00095 
00096    if (!ast_strlen_zero(data)) {
00097       context = ast_strdupa(data);
00098       exten = strsep(&context, "@");
00099    }
00100 
00101    if (ast_strlen_zero(exten))
00102       exten = "s";
00103    if (ast_strlen_zero(context))
00104       context = "default";
00105    
00106    ast_pbx_outgoing_exten(chantech, AST_FORMAT_SLINEAR, chandata, TIMEOUT * 1000, context, exten, 1, &reason, 0, NULL, NULL, NULL, NULL, NULL);
00107 
00108    return CLI_SUCCESS;
00109 }

static int unload_module ( void   )  [static]

Unload orginate module.

Definition at line 178 of file res_clioriginate.c.

References ARRAY_LEN, and ast_cli_unregister_multiple().


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Call origination from the CLI" , .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, } [static]

Definition at line 191 of file res_clioriginate.c.

Definition at line 191 of file res_clioriginate.c.

struct ast_cli_entry cli_cliorig[] [static]

Initial value:

 {
   AST_CLI_DEFINE(handle_orig, "Originate a call"),
}

Definition at line 173 of file res_clioriginate.c.


Generated on Wed Oct 28 11:53:04 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6