Thu Oct 8 21:56:26 2009

Asterisk developer's documentation


func_channel.c File Reference

Channel info dialplan function. More...

#include "asterisk.h"
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/logger.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/indications.h"
#include "asterisk/stringfields.h"

Include dependency graph for func_channel.c:

Go to the source code of this file.

Defines

#define locked_copy_string(chan, dest, source, len)
#define locked_string_field_set(chan, field, source)

Functions

 AST_MODULE_INFO_STANDARD (ASTERISK_GPL_KEY,"Channel information dialplan function")
static int func_channel_read (struct ast_channel *chan, char *function, char *data, char *buf, size_t len)
static int func_channel_write (struct ast_channel *chan, char *function, char *data, const char *value)
static int load_module (void)
static int unload_module (void)

Variables

static struct ast_custom_function channel_function
char * transfercapability_table [0x20]


Detailed Description

Channel info dialplan function.

Author:
Kevin P. Fleming <kpfleming@digium.com>

Definition in file func_channel.c.


Define Documentation

#define locked_copy_string ( chan,
dest,
source,
len   ) 

Value:

do { \
      ast_channel_lock(chan); \
      ast_copy_string(dest, source, len); \
      ast_channel_unlock(chan); \
   } while (0)

Definition at line 43 of file func_channel.c.

Referenced by func_channel_read().

#define locked_string_field_set ( chan,
field,
source   ) 

Value:

do { \
      ast_channel_lock(chan); \
      ast_string_field_set(chan, field, source); \
      ast_channel_unlock(chan); \
   } while (0)

Definition at line 49 of file func_channel.c.

Referenced by func_channel_write().


Function Documentation

AST_MODULE_INFO_STANDARD ( ASTERISK_GPL_KEY  ,
"Channel information dialplan function"   
)

static int func_channel_read ( struct ast_channel chan,
char *  function,
char *  data,
char *  buf,
size_t  len 
) [static]

Definition at line 62 of file func_channel.c.

References ast_channel::_state, AST_FORMAT_AUDIO_MASK, AST_FORMAT_VIDEO_MASK, ast_getformatname(), ast_log(), ast_print_group(), ast_state2str(), ast_channel::callgroup, tone_zone::country, ast_channel_tech::func_channel_read, locked_copy_string, LOG_WARNING, ast_channel::nativeformats, ast_channel::readformat, ast_channel::tech, ast_channel::transfercapability, ast_channel_tech::type, ast_channel::writeformat, and ast_channel::zone.

00064 {
00065    int ret = 0;
00066 
00067    if (!strcasecmp(data, "audionativeformat"))
00068       /* use the _multiple version when chan->nativeformats holds multiple formats */
00069       /* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_AUDIO_MASK); */
00070       ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_AUDIO_MASK), len);
00071    else if (!strcasecmp(data, "videonativeformat"))
00072       /* use the _multiple version when chan->nativeformats holds multiple formats */
00073       /* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_VIDEO_MASK); */
00074       ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_VIDEO_MASK), len);
00075    else if (!strcasecmp(data, "audioreadformat"))
00076       ast_copy_string(buf, ast_getformatname(chan->readformat), len);
00077    else if (!strcasecmp(data, "audiowriteformat"))
00078       ast_copy_string(buf, ast_getformatname(chan->writeformat), len);
00079    else if (!strcasecmp(data, "tonezone") && chan->zone)
00080       locked_copy_string(chan, buf, chan->zone->country, len);
00081    else if (!strcasecmp(data, "language"))
00082       locked_copy_string(chan, buf, chan->language, len);
00083    else if (!strcasecmp(data, "musicclass"))
00084       locked_copy_string(chan, buf, chan->musicclass, len);
00085    else if (!strcasecmp(data, "state"))
00086       locked_copy_string(chan, buf, ast_state2str(chan->_state), len);
00087    else if (!strcasecmp(data, "channeltype"))
00088       locked_copy_string(chan, buf, chan->tech->type, len);
00089    else if (!strcasecmp(data, "transfercapability"))
00090       locked_copy_string(chan, buf, transfercapability_table[chan->transfercapability & 0x1f], len);
00091    else if (!strcasecmp(data, "callgroup")) {
00092       char groupbuf[256];
00093       locked_copy_string(chan, buf,  ast_print_group(groupbuf, sizeof(groupbuf), chan->callgroup), len);
00094    } else if (!chan->tech->func_channel_read
00095        || chan->tech->func_channel_read(chan, function, data, buf, len)) {
00096       ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n", data);
00097       ret = -1;
00098    }
00099 
00100    return ret;
00101 }

static int func_channel_write ( struct ast_channel chan,
char *  function,
char *  data,
const char *  value 
) [static]

Definition at line 103 of file func_channel.c.

References ast_channel_setoption(), ast_get_group(), ast_get_indication_zone(), ast_log(), AST_OPTION_RXGAIN, AST_OPTION_TXGAIN, ast_channel::callgroup, ast_channel_tech::func_channel_write, language, locked_string_field_set, LOG_ERROR, LOG_WARNING, musicclass, ast_channel::tech, ast_channel::transfercapability, and ast_channel::zone.

00105 {
00106    int ret = 0;
00107    signed char gainset;
00108 
00109    if (!strcasecmp(data, "language"))
00110       locked_string_field_set(chan, language, value);
00111    else if (!strcasecmp(data, "musicclass"))
00112       locked_string_field_set(chan, musicclass, value);
00113    else if (!strcasecmp(data, "tonezone")) {
00114       struct tone_zone *new_zone;
00115       if (!(new_zone = ast_get_indication_zone(value))) {
00116          ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", value);
00117          ret = -1;   
00118       } else 
00119          chan->zone = new_zone;
00120    } else if (!strcasecmp(data, "callgroup"))
00121       chan->callgroup = ast_get_group(value);
00122    else if (!strcasecmp(data, "txgain")) {
00123       sscanf(value, "%hhd", &gainset);
00124       ast_channel_setoption(chan, AST_OPTION_TXGAIN, &gainset, sizeof(gainset), 0);
00125    } else if (!strcasecmp(data, "rxgain")) {
00126       sscanf(value, "%hhd", &gainset);
00127       ast_channel_setoption(chan, AST_OPTION_RXGAIN, &gainset, sizeof(gainset), 0);
00128    } else if (!strcasecmp(data, "transfercapability")) {
00129       unsigned short i;
00130       for (i = 0; i < 0x20; i++) {
00131          if (!strcasecmp(transfercapability_table[i], value) && strcmp(value, "UNK")) {
00132             chan->transfercapability = i;
00133             break;
00134          }
00135       }
00136    } else if (!chan->tech->func_channel_write
00137        || chan->tech->func_channel_write(chan, function, data, value)) {
00138       ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n",
00139             data);
00140       ret = -1;
00141    }
00142 
00143    return ret;
00144 }

static int load_module ( void   )  [static]

Definition at line 197 of file func_channel.c.

References ast_custom_function_register().

00198 {
00199    return ast_custom_function_register(&channel_function);
00200 }

static int unload_module ( void   )  [static]

Definition at line 192 of file func_channel.c.

References ast_custom_function_unregister().

00193 {
00194    return ast_custom_function_unregister(&channel_function);
00195 }


Variable Documentation

Definition at line 146 of file func_channel.c.

Initial value:

 {
   "SPEECH", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
   "DIGITAL", "RESTRICTED_DIGITAL", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
   "3K1AUDIO", "DIGITAL_W_TONES", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
   "VIDEO", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", }

Definition at line 56 of file func_channel.c.


Generated on Thu Oct 8 21:56:26 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6