cli.h File Reference

Standard Command Line Interface. More...

#include "asterisk/linkedlists.h"

Include dependency graph for cli.h:

Data Structures
struct	ast_cli_args
struct	ast_cli_entry
	descriptor for a cli entry. More...
Defines
#define	ast_cli_command(fd, s) ast_cli_command_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, s)
#define	ast_cli_command_multiple(fd, size, s) ast_cli_command_multiple_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, size, s)
#define	AST_CLI_COMPLETE_EOF "_EOF_"
#define	AST_CLI_DEFINE(fn, txt,...) { .handler = fn, .summary = txt, ## __VA_ARGS__ }
#define	AST_MAX_ARGS 64
#define	AST_MAX_CMD_LEN 16
#define	CLI_FAILURE (char *)RESULT_FAILURE
#define	CLI_NO_PERMS -1
#define	CLI_SHOWUSAGE (char *)RESULT_SHOWUSAGE
#define	CLI_SUCCESS (char *)RESULT_SUCCESS
#define	ESS(x) ((x) == 1 ? "" : "s")
#define	RESULT_FAILURE 2
#define	RESULT_SHOWUSAGE 1
#define	RESULT_SUCCESS 0
Typedefs
typedef char (	cli_fn )(struct ast_cli_entry e, int cmd, struct ast_cli_args a)
Enumerations
enum	ast_cli_fn { CLI_INIT = -2, CLI_GENERATE = -3, CLI_HANDLER = -4 }
	calling arguments for new-style handlers. More...
Functions
void	ast_cli (int fd, const char *fmt,...)
int	ast_cli_command_full (int uid, int gid, int fd, const char *s)
	Interprets a command Interpret a command s, sending output to fd if uid:gid has permissions to run this command. uid = CLI_NO_PERMS to avoid checking user permissions gid = CLI_NO_PERMS to avoid checking group permissions.
int	ast_cli_command_multiple_full (int uid, int gid, int fd, size_t size, const char *s)
	Executes multiple CLI commands Interpret strings separated by NULL and execute each one, sending output to fd if uid has permissions, uid = CLI_NO_PERMS to avoid checking users permissions. gid = CLI_NO_PERMS to avoid checking group permissions.
char *	ast_cli_complete (const char word, char const choices[], int pos)
char **	ast_cli_completion_matches (const char , const char )
	Generates a NULL-terminated array of strings that 1) begin with the string in the second parameter, and 2) are valid in a command after the string in the first parameter.
char *	ast_cli_generator (const char , const char , int)
	Readline madness Useful for readline, that's about it.
int	ast_cli_generatornummatches (const char , const char )
	Return the number of unique matches for the generator.
int	ast_cli_register (struct ast_cli_entry *e)
	Registers a command or an array of commands.
int	ast_cli_register_multiple (struct ast_cli_entry *e, int len)
	Register multiple commands.
int	ast_cli_unregister (struct ast_cli_entry *e)
	Unregisters a command or an array of commands.
int	ast_cli_unregister_multiple (struct ast_cli_entry *e, int len)
	Unregister multiple commands.
char *	ast_complete_channels (const char line, const char word, int pos, int state, int rpos)
	Command completion for the list of active channels.

Detailed Description

Standard Command Line Interface.

Definition in file cli.h.

Define Documentation

#define ast_cli_command	(	fd,
		s		)	ast_cli_command_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, s)

Definition at line 210 of file cli.h.

Referenced by action_command(), cli_activate(), cli_alias_passthrough(), consolehandler(), exit_completely(), handle_cli_config_reload(), rpt_exec(), and run_startup_commands().

#define ast_cli_command_multiple	(	fd,
		size,
		s	)	ast_cli_command_multiple_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, size, s)

Definition at line 226 of file cli.h.

#define AST_CLI_COMPLETE_EOF "_EOF_"

Definition at line 51 of file cli.h.

Referenced by ast_el_strtoarr(), cli_complete(), and handle_commandmatchesarray().

#define AST_CLI_DEFINE	(	fn,
		txt,
		...	)	{ .handler = fn, .summary = txt, ## __VA_ARGS__ }

Definition at line 176 of file cli.h.

#define AST_MAX_ARGS 64

Definition at line 49 of file cli.h.

Referenced by __ast_cli_generator(), ast_cli_command_full(), and handle_cli_check_permissions().

#define AST_MAX_CMD_LEN 16

Definition at line 47 of file cli.h.

Referenced by __ast_cli_register(), and find_best().

#define CLI_FAILURE (char *)RESULT_FAILURE

Definition at line 45 of file cli.h.

Referenced by ais_clm_show_members(), aji_test(), ast_cli_command_full(), cli_console_active(), cli_console_answer(), cli_console_autoanswer(), cli_console_dial(), cli_console_flash(), cli_console_hangup(), cli_console_mute(), cli_console_sendtext(), cli_odbc_read(), cli_odbc_write(), cli_realtime_destroy(), cli_realtime_store(), cli_realtime_update(), cli_realtime_update2(), cli_tps_ping(), console_answer(), console_autoanswer(), console_cmd(), console_dial(), console_do_answer(), console_flash(), console_hangup(), console_sendtext(), console_transfer(), dahdi_destroy_channel(), dahdi_restart_cmd(), dahdi_set_dnd(), dahdi_set_hwgain(), dahdi_set_swgain(), dahdi_show_channel(), dahdi_show_channels(), dahdi_show_status(), handle_cli_ael_reload(), handle_cli_agi_add_cmd(), handle_cli_agi_show(), handle_cli_check_permissions(), handle_cli_core_show_channeltype(), handle_cli_devstate_change(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_add_ignorepat(), handle_cli_dialplan_add_include(), handle_cli_dialplan_remove_extension(), handle_cli_dialplan_remove_ignorepat(), handle_cli_dialplan_remove_include(), handle_cli_dialplan_save(), handle_cli_file_convert(), handle_cli_iax2_set_debug(), handle_cli_iax2_show_peers(), handle_cli_indication_add(), handle_cli_indication_remove(), handle_cli_realtime_pgsql_status(), handle_cli_ulimit(), handle_commandmatchesarray(), handle_debug_dialplan(), handle_load(), handle_logger_reload(), handle_logger_rotate(), handle_minivm_list_templates(), handle_minivm_show_users(), handle_minivm_show_zones(), handle_queue_add_member(), handle_queue_pause_member(), handle_queue_remove_member(), handle_queue_set_member_penalty(), handle_redirect(), handle_set_chanvar(), handle_show_application(), handle_show_chanvar(), handle_show_dialplan(), handle_show_function(), handle_unload(), handle_verbose(), handle_voicemail_show_users(), handle_voicemail_show_zones(), meetme_cmd(), meetme_show_cmd(), realtime_ldap_status(), res2cli(), rtcp_do_debug_ip(), rtp_do_debug_ip(), show_users_realtime(), sip_cli_notify(), and timing_test().

#define CLI_NO_PERMS -1

Definition at line 37 of file cli.h.

Referenced by cli_has_permissions().

#define CLI_SHOWUSAGE (char *)RESULT_SHOWUSAGE

Definition at line 44 of file cli.h.

#define CLI_SUCCESS (char *)RESULT_SUCCESS

Definition at line 43 of file cli.h.

#define ESS ( x ) ((x) == 1 ? "" : "s")

In many cases we need to print singular or plural words depending on a count. This macro helps us e.g. printf("we have %d object%s", n, ESS(n));

Definition at line 58 of file cli.h.

Referenced by cli_realtime_destroy(), cli_realtime_update(), cli_realtime_update2(), group_show_channels(), handle_chanlist(), handle_cli_status(), handle_parkedcalls(), handle_showcalls(), print_uptimestr(), and sip_show_channels().

#define RESULT_FAILURE 2

#define RESULT_SHOWUSAGE 1

Definition at line 40 of file cli.h.

Referenced by __iax2_show_peers(), agi_handle_command(), console_key(), console_unkey(), handle_autohangup(), handle_channelstatus(), handle_cli_iax2_show_peers(), handle_controlstreamfile(), handle_dbdel(), handle_dbdeltree(), handle_dbget(), handle_dbput(), handle_exec(), handle_getdata(), handle_getoption(), handle_getvariable(), handle_getvariablefull(), handle_gosub(), handle_hangup(), handle_recordfile(), handle_recvchar(), handle_recvtext(), handle_sayalpha(), handle_saydate(), handle_saydatetime(), handle_saydigits(), handle_saynumber(), handle_sayphonetic(), handle_saytime(), handle_sendimage(), handle_sendtext(), handle_setcontext(), handle_setextension(), handle_setmusic(), handle_setpriority(), handle_speechactivategrammar(), handle_speechdeactivategrammar(), handle_speechloadgrammar(), handle_speechrecognize(), handle_speechset(), handle_speechunloadgrammar(), handle_streamfile(), handle_tddmode(), handle_verbose(), handle_waitfordigit(), radio_active(), radio_tune(), res2cli(), rpt_do_cmd(), rpt_do_debug(), rpt_do_dump(), rpt_do_fun(), rpt_do_fun1(), rpt_do_lstats(), rpt_do_nodes(), rpt_do_reload(), rpt_do_restart(), and rpt_do_stats().

#define RESULT_SUCCESS 0

Definition at line 39 of file cli.h.

Referenced by __iax2_show_peers(), agi_handle_command(), console_key(), console_unkey(), dahdi_destroy_channel(), dahdi_destroy_channel_bynum(), handle_answer(), handle_autohangup(), handle_channelstatus(), handle_controlstreamfile(), handle_dbdel(), handle_dbdeltree(), handle_dbget(), handle_dbput(), handle_getdata(), handle_getoption(), handle_getvariable(), handle_getvariablefull(), handle_gosub(), handle_hangup(), handle_noop(), handle_queue_pause_member(), handle_queue_set_member_penalty(), handle_recordfile(), handle_recvchar(), handle_recvtext(), handle_sayalpha(), handle_saydate(), handle_saydatetime(), handle_saydigits(), handle_saynumber(), handle_sayphonetic(), handle_saytime(), handle_sendimage(), handle_sendtext(), handle_setcallerid(), handle_setcontext(), handle_setextension(), handle_setmusic(), handle_setpriority(), handle_setvariable(), handle_showcalls(), handle_speechactivategrammar(), handle_speechcreate(), handle_speechdeactivategrammar(), handle_speechdestroy(), handle_speechloadgrammar(), handle_speechrecognize(), handle_speechset(), handle_speechunloadgrammar(), handle_streamfile(), handle_tddmode(), handle_verbose(), handle_waitfordigit(), logger_reload(), manager_iax2_show_netstats(), manager_iax2_show_peer_list(), manager_list_voicemail_users(), manager_parking_status(), manager_queue_rule_show(), manager_queues_show(), manager_queues_status(), manager_queues_summary(), manager_rpt_local_nodes(), radio_active(), radio_set_debug(), radio_set_debug_off(), radio_set_xpmr_debug(), radio_tune(), res2cli(), rpt_do_cmd(), rpt_do_debug(), rpt_do_dump(), rpt_do_local_nodes(), rpt_do_lstats(), rpt_do_nodes(), rpt_do_stats(), set_member_paused(), and set_member_penalty().

Typedef Documentation

typedef char*(* cli_fn)(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)

Definition at line 149 of file cli.h.

Enumeration Type Documentation

enum ast_cli_fn

calling arguments for new-style handlers.

CLI command API

Enumerator:

CLI_INIT
CLI_GENERATE
CLI_HANDLER

Definition at line 131 of file cli.h.

00131                 {
00132    CLI_INIT = -2,    /* return the usage string */
00133    CLI_GENERATE = -3,   /* behave as 'generator', remap argv to struct ast_cli_args */
00134    CLI_HANDLER = -4, /* run the normal handler */
00135 };

Function Documentation

void ast_cli	(	int	fd,
		const char *	fmt,
			...
	)

Definition at line 101 of file cli.c.

References ast_carefulwrite(), AST_CLI_INITLEN, AST_DYNSTR_BUILD_FAILED, ast_str_buffer(), ast_str_set_va(), ast_str_strlen(), ast_str_thread_get(), and buf.

00102 {
00103    int res;
00104    struct ast_str *buf;
00105    va_list ap;
00106 
00107    if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
00108       return;
00109 
00110    va_start(ap, fmt);
00111    res = ast_str_set_va(&buf, 0, fmt, ap);
00112    va_end(ap);
00113 
00114    if (res != AST_DYNSTR_BUILD_FAILED) {
00115       ast_carefulwrite(fd, ast_str_buffer(buf), ast_str_strlen(buf), 100);
00116    }
00117 }

int ast_cli_command_full	(	int	uid,
		int	gid,
		int	fd,
		const char *	s
	)

Interprets a command Interpret a command s, sending output to fd if uid:gid has permissions to run this command. uid = CLI_NO_PERMS to avoid checking user permissions gid = CLI_NO_PERMS to avoid checking group permissions.

Parameters:

	uid	User ID that is trying to run the command.
	gid	Group ID that is trying to run the command.
	fd	pipe
	s	incoming string

Return values:

	0	on success
	-1	on failure

Definition at line 2259 of file cli.c.

References ast_atomic_fetchadd_int(), ast_cli(), ast_free, ast_join(), AST_MAX_ARGS, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, CLI_FAILURE, CLI_HANDLER, cli_has_permissions(), CLI_SHOWUSAGE, ast_cli_args::fd, find_best(), find_cli(), ast_cli_entry::handler, ast_cli_entry::inuse, parse_args(), S_OR, and ast_cli_entry::usage.

Referenced by ast_cli_command_multiple_full().

02261 02262 02263 02264 02265 02266 02267 02268 02269 02270 02271 02272 02273 02274 02275 02276 02277 02278 02279 02280 02281 02282 02283 02284    } 02285 02286 02287 02288 02289 02290 02291 02292    } 02293 02294 02295 02296 02297 02298 02299 02300 02301 02302 02303 02304 02305 02306 02307    } 02308 02309 done: 02310 02311 02312 }

class="fragment">02260 { char *args[AST_MAX_ARGS + 1]; struct ast_cli_entry *e; int x; char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL); char tmp[AST_MAX_ARGS + 1]; char *retval = NULL; struct ast_cli_args a = { .fd = fd, .argc = x, .argv = args+1 }; if (duplicate == NULL) return -1; if (x < 1) /* We need at least one entry, otherwise ignore */ goto done; AST_RWLIST_RDLOCK(&helpers); e = find_cli(args + 1, 0); if (e) ast_atomic_fetchadd_int(&e->inuse, 1); AST_RWLIST_UNLOCK(&helpers); if (e == NULL) { ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1)); goto done; ast_join(tmp, sizeof(tmp), args + 1); /* Check if the user has rights to run this command. */ if (!cli_has_permissions(uid, gid, tmp)) { ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp); ast_free(duplicate); return 0; /* * Within the handler, argv[-1] contains a pointer to the ast_cli_entry. * Remember that the array returned by parse_args is NULL-terminated. */ args[0] = (char *)e; retval = e->handler(e, CLI_HANDLER, &a); if (retval == CLI_SHOWUSAGE) { ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n")); } else { if (retval == CLI_FAILURE) ast_cli(fd, "Command '%s' failed.\n", s); ast_atomic_fetchadd_int(&e->inuse, -1); ast_free(duplicate); return 0;

int ast_cli_command_multiple_full	(	int	uid,
		int	gid,
		int	fd,
		size_t	size,
		const char *	s
	)

Executes multiple CLI commands Interpret strings separated by NULL and execute each one, sending output to fd if uid has permissions, uid = CLI_NO_PERMS to avoid checking users permissions. gid = CLI_NO_PERMS to avoid checking group permissions.

Parameters:

	uid	User ID that is trying to run the command.
	gid	Group ID that is trying to run the command.
	fd	pipe
	size	is the total size of the string
	s	incoming string

Return values:

number

of commands executed

Definition at line 2314 of file cli.c.

References ast_cli_command_full().

Referenced by netconsole().

02315 {
02316    char cmd[512];
02317    int x, y = 0, count = 0;
02318 
02319    for (x = 0; x < size; x++) {
02320       cmd[y] = s[x];
02321       y++;
02322       if (s[x] == '\0') {
02323          ast_cli_command_full(uid, gid, fd, cmd);
02324          y = 0;
02325          count++;
02326       }
02327    }
02328    return count;
02329 }

char* ast_cli_complete	(	const char *	word,
		char *const	choices[],
		int	pos
	)

Helper function to generate cli entries from a NULL-terminated array. Returns the n-th matching entry from the array, or NULL if not found. Can be used to implement generate() for static entries as below (in this example we complete the word in position 2):

    char *my_generate(const char *line, const char *word, int pos, int n)
    {
        static char *choices = { "one", "two", "three", NULL };
   if (pos == 2)
         return ast_cli_complete(word, choices, n);
   else
      return NULL;
    }

Definition at line 1379 of file cli.c.

References ast_strdup, ast_strlen_zero(), and len().

Referenced by complete_meetmecmd(), handle_cli_devstate_change(), handle_cli_iax2_prune_realtime(), handle_orig(), handle_show_applications(), and sip_prune_realtime().

01380 {
01381    int i, which = 0, len;
01382    len = ast_strlen_zero(word) ? 0 : strlen(word);
01383 
01384    for (i = 0; choices[i]; i++) {
01385       if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
01386          return ast_strdup(choices[i]);
01387    }
01388    return NULL;
01389 }

char** ast_cli_completion_matches	(	const char *	,
		const char *
	)

Generates a NULL-terminated array of strings that 1) begin with the string in the second parameter, and 2) are valid in a command after the string in the first parameter.

The first entry (offset 0) of the result is the longest common substring in the results, useful to extend the string that has been completed. Subsequent entries are all possible values, followed by a NULL. All strings and the array itself are malloc'ed and must be freed by the caller.

Definition at line 2110 of file cli.c.

References ast_cli_generator(), ast_copy_string(), ast_malloc, and ast_realloc.

Referenced by cli_complete(), and handle_commandmatchesarray().

02111 {
02112    char **match_list = NULL, *retstr, *prevstr;
02113    size_t match_list_len, max_equal, which, i;
02114    int matches = 0;
02115 
02116    /* leave entry 0 free for the longest common substring */
02117    match_list_len = 1;
02118    while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
02119       if (matches + 1 >= match_list_len) {
02120          match_list_len <<= 1;
02121          if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
02122             return NULL;
02123       }
02124       match_list[++matches] = retstr;
02125    }
02126 
02127    if (!match_list)
02128       return match_list; /* NULL */
02129 
02130    /* Find the longest substring that is common to all results
02131     * (it is a candidate for completion), and store a copy in entry 0.
02132     */
02133    prevstr = match_list[1];
02134    max_equal = strlen(prevstr);
02135    for (which = 2; which <= matches; which++) {
02136       for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
02137          continue;
02138       max_equal = i;
02139    }
02140 
02141    if (!(retstr = ast_malloc(max_equal + 1)))
02142       return NULL;
02143    
02144    ast_copy_string(retstr, match_list[1], max_equal + 1);
02145    match_list[0] = retstr;
02146 
02147    /* ensure that the array is NULL terminated */
02148    if (matches + 1 >= match_list_len) {
02149       if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
02150          return NULL;
02151    }
02152    match_list[matches + 1] = NULL;
02153 
02154    return match_list;
02155 }

char* ast_cli_generator	(	const char *	,
		const char *	,
		int
	)

Readline madness Useful for readline, that's about it.

Return values:

	0	on success
	-1	on failure

Definition at line 2254 of file cli.c.

References __ast_cli_generator().

Referenced by ast_cli_completion_matches(), ast_cli_generatornummatches(), cli_alias_passthrough(), and handle_cli_check_permissions().

02255 {
02256    return __ast_cli_generator(text, word, state, 1);
02257 }

int ast_cli_generatornummatches	(	const char *	,
		const char *
	)

Return the number of unique matches for the generator.

Definition at line 2093 of file cli.c.

References ast_cli_generator(), ast_free, and buf.

Referenced by handle_commandnummatches().

02094 {
02095    int matches = 0, i = 0;
02096    char *buf = NULL, *oldbuf = NULL;
02097 
02098    while ((buf = ast_cli_generator(text, word, i++))) {
02099       if (!oldbuf || strcmp(buf,oldbuf))
02100          matches++;
02101       if (oldbuf)
02102          ast_free(oldbuf);
02103       oldbuf = buf;
02104    }
02105    if (oldbuf)
02106       ast_free(oldbuf);
02107    return matches;
02108 }

int ast_cli_register ( struct ast_cli_entry * e )

Registers a command or an array of commands.

Parameters:

e

which cli entry to register. Register your own command

Return values:

	0	on success
	-1	on failure

Definition at line 1920 of file cli.c.

References __ast_cli_register().

Referenced by ast_cdr_engine_init(), ast_cli_register_multiple(), dnsmgr_init(), do_reload(), load_config(), and load_module().

01921 {
01922    return __ast_cli_register(e, NULL);
01923 }

int ast_cli_register_multiple	(	struct ast_cli_entry *	e,
		int	len
	)

Register multiple commands.

Parameters:

	e	pointer to first cli entry to register
	len	number of entries to register

Definition at line 1928 of file cli.c.

References ast_cli_register().

Referenced by __ast_mm_init(), __ast_register_translator(), __init_manager(), ast_ais_clm_load_module(), ast_ais_evt_load_module(), ast_builtins_init(), ast_channels_init(), ast_features_init(), ast_file_init(), ast_http_init(), ast_image_init(), ast_indications_init(), ast_rtp_init(), ast_timing_init(), ast_tps_init(), ast_udptl_init(), ast_utils_init(), astdb_init(), astobj2_init(), crypto_init(), iax_provision_init(), init_framer(), init_logger(), load_module(), load_pbx(), main(), and register_config_cli().

01929 {
01930    int i, res = 0;
01931 
01932    for (i = 0; i < len; i++)
01933       res |= ast_cli_register(e + i);
01934 
01935    return res;
01936 }

int ast_cli_unregister ( struct ast_cli_entry * e )

Unregisters a command or an array of commands.

Parameters:

e

which cli entry to unregister Unregister your own command. You must pass a completed ast_cli_entry structure

Returns:: 0

Definition at line 1914 of file cli.c.

References __ast_cli_unregister().

Referenced by alias_destroy(), ast_cli_unregister_multiple(), do_reload(), load_module(), and unload_module().

01915 {
01916    return __ast_cli_unregister(e, NULL);
01917 }

int ast_cli_unregister_multiple	(	struct ast_cli_entry *	e,
		int	len
	)

Unregister multiple commands.

Parameters:

	e	pointer to first cli entry to unregister
	len	number of entries to unregister

Definition at line 1938 of file cli.c.

References ast_cli_unregister().

Referenced by __unload_module(), ast_ais_clm_unload_module(), iax_provision_unload(), load_module(), and unload_module().

01939 {
01940    int i, res = 0;
01941 
01942    for (i = 0; i < len; i++)
01943       res |= ast_cli_unregister(e + i);
01944 
01945    return res;
01946 }

char* ast_complete_channels	(	const char *	line,
		const char *	word,
		int	pos,
		int	state,
		int	rpos
	)

Command completion for the list of active channels.

This can be called from a CLI command completion function that wants to complete from the list of active channels. 'rpos' is the required position in the command. This function will return NULL immediately if 'rpos' is not the same as the current position, 'pos'.

Definition at line 1391 of file cli.c.

References ast_channel_unlock, ast_channel_walk_locked(), ast_strdup, and ast_channel::name.

Referenced by complete_ch(), handle_cli_agi_add_cmd(), handle_cli_mixmonitor(), handle_core_set_debug_channel(), handle_redirect(), handle_set_chanvar(), handle_show_chanvar(), handle_showchan(), and handle_softhangup().

01392 {
01393    struct ast_channel *c = NULL;
01394    int which = 0;
01395    int wordlen;
01396    char notfound = '\0';
01397    char *ret = &notfound; /* so NULL can break the loop */
01398 
01399    if (pos != rpos)
01400       return NULL;
01401 
01402    wordlen = strlen(word); 
01403 
01404    while (ret == &notfound && (c = ast_channel_walk_locked(c))) {
01405       if (!strncasecmp(word, c->name, wordlen) && ++which > state)
01406          ret = ast_strdup(c->name);
01407       ast_channel_unlock(c);
01408    }
01409    return ret == &notfound ? NULL : ret;
01410 }

Asterisk developer's documentation

cli.h File Reference

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation