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_CLI_ONOFF(x) (x) ? "On" : "Off"
	return On or Off depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point).
#define	AST_CLI_YESNO(x) (x) ? "Yes" : "No"
	return Yes or No depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point).
#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
Enumerations
enum	ast_cli_command { 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, const 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 226 of file cli.h.

Referenced by action_command(), cli_alias_passthrough(), consolehandler(), handle_cli_config_reload(), 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 242 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 191 of file cli.h.

#define AST_CLI_ONOFF ( x ) (x) ? "On" : "Off"

return On or Off depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point).

Definition at line 72 of file cli.h.

Referenced by sip_show_settings().

#define AST_CLI_YESNO ( x ) (x) ? "Yes" : "No"

return Yes or No depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point).

Definition at line 65 of file cli.h.

Referenced by _sip_show_peer(), action_coresettings(), display_nat_warning(), handle_feature_show(), handle_manager_show_settings(), handle_skinny_show_settings(), show_channels_cb(), sip_show_channel(), sip_show_mwi(), sip_show_settings(), sip_show_user(), and sip_show_users().

#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 _sip_show_peers(), ais_clm_show_members(), aji_cli_create_collection(), aji_cli_create_leafnode(), aji_cli_delete_pubsub_node(), aji_cli_list_pubsub_nodes(), aji_cli_purge_pubsub_nodes(), 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_fax_show_sessions(), 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_status(), handle_cc_status(), handle_chanlist(), handle_cli_ael_reload(), handle_cli_agi_add_cmd(), handle_cli_agi_show(), handle_cli_check_permissions(), handle_cli_core_show_channeltype(), handle_cli_core_show_translation(), handle_cli_data_get(), 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_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_showchan(), handle_softhangup(), handle_unload(), handle_verbose(), handle_voicemail_show_users(), handle_voicemail_show_zones(), meetme_cmd_helper(), meetme_show_cmd(), realtime_ldap_status(), 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_SHOWUSAGE 1

Definition at line 40 of file cli.h.

Referenced by __iax2_show_peers(), agi_handle_command(), 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(), and handle_waitfordigit().

#define RESULT_SUCCESS 0

Definition at line 39 of file cli.h.

Referenced by __iax2_show_peers(), agi_handle_command(), cli_fax_show_session(), dahdi_destroy_channel(), dahdi_destroy_channel_bynum(), do_monitor(), 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(), locals_show(), logger_reload(), manager_data_get(), 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(), set_member_paused(), and set_member_penalty().

Enumeration Type Documentation

enum ast_cli_command

calling arguments for new-style handlers.

CLI command API

Enumerator:

CLI_INIT
CLI_GENERATE
CLI_HANDLER

Definition at line 145 of file cli.h.

00145                      {
00146    CLI_INIT = -2,    /* return the usage string */
00147    CLI_GENERATE = -3,   /* behave as 'generator', remap argv to struct ast_cli_args */
00148    CLI_HANDLER = -4, /* run the normal handler */
00149 };

Function Documentation

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

Definition at line 106 of file cli.c.

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

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

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 2531 of file cli.c.

References args, 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().

02533 02534 02535 02536 02537 02538 02539 02540 02541 02542 02543 02544 02545 02546 02547 02548 02549 02550 02551 02552 02553 02554 02555 02556    } 02557 02558 02559 02560 02561 02562 02563 02564    } 02565 02566 02567 02568 02569 02570 02571 02572 02573 02574 02575 02576 02577 02578 02579    } 02580 02581 done: 02582 02583 02584 }

class="fragment">02532 { const 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 2586 of file cli.c.

References ast_cli_command_full().

Referenced by netconsole().

02587 {
02588    char cmd[512];
02589    int x, y = 0, count = 0;
02590 
02591    for (x = 0; x < size; x++) {
02592       cmd[y] = s[x];
02593       y++;
02594       if (s[x] == '\0') {
02595          ast_cli_command_full(uid, gid, fd, cmd);
02596          y = 0;
02597          count++;
02598       }
02599    }
02600    return count;
02601 }

char* ast_cli_complete	(	const char *	word,
		const 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 const char * const choices[] = { "one", "two", "three", NULL };
   if (pos == 2)
         return ast_cli_complete(word, choices, n);
   else
      return NULL;
    }

Definition at line 1536 of file cli.c.

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

Referenced by event_dump_cache(), handle_cc_kill(), handle_cli_core_show_translation(), handle_cli_devstate_change(), handle_cli_iax2_prune_realtime(), handle_memory_atexit_list(), handle_memory_atexit_summary(), handle_orig(), handle_show_applications(), and sip_prune_realtime().

01537 {
01538    int i, which = 0, len;
01539    len = ast_strlen_zero(word) ? 0 : strlen(word);
01540 
01541    for (i = 0; choices[i]; i++) {
01542       if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
01543          return ast_strdup(choices[i]);
01544    }
01545    return NULL;
01546 }

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 2369 of file cli.c.

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

Referenced by cli_complete(), and handle_commandmatchesarray().

02370 {
02371    char **match_list = NULL, *retstr, *prevstr;
02372    char **new_list;
02373    size_t match_list_len, max_equal, which, i;
02374    int matches = 0;
02375 
02376    /* leave entry 0 free for the longest common substring */
02377    match_list_len = 1;
02378    while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
02379       if (matches + 1 >= match_list_len) {
02380          match_list_len <<= 1;
02381          new_list = ast_realloc(match_list, match_list_len * sizeof(*match_list));
02382          if (!new_list) {
02383             destroy_match_list(match_list, matches);
02384             return NULL;
02385          }
02386          match_list = new_list;
02387       }
02388       match_list[++matches] = retstr;
02389    }
02390 
02391    if (!match_list) {
02392       return match_list; /* NULL */
02393    }
02394 
02395    /* Find the longest substring that is common to all results
02396     * (it is a candidate for completion), and store a copy in entry 0.
02397     */
02398    prevstr = match_list[1];
02399    max_equal = strlen(prevstr);
02400    for (which = 2; which <= matches; which++) {
02401       for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
02402          continue;
02403       max_equal = i;
02404    }
02405 
02406    retstr = ast_malloc(max_equal + 1);
02407    if (!retstr) {
02408       destroy_match_list(match_list, matches);
02409       return NULL;
02410    }
02411    ast_copy_string(retstr, match_list[1], max_equal + 1);
02412    match_list[0] = retstr;
02413 
02414    /* ensure that the array is NULL terminated */
02415    if (matches + 1 >= match_list_len) {
02416       new_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list));
02417       if (!new_list) {
02418          ast_free(retstr);
02419          destroy_match_list(match_list, matches);
02420          return NULL;
02421       }
02422       match_list = new_list;
02423    }
02424    match_list[matches + 1] = NULL;
02425 
02426    return match_list;
02427 }

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 2526 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().

02527 {
02528    return __ast_cli_generator(text, word, state, 1);
02529 }

int ast_cli_generatornummatches	(	const char *	,
		const char *
	)

Return the number of unique matches for the generator.

Definition at line 2340 of file cli.c.

References ast_cli_generator(), and ast_free.

Referenced by handle_commandnummatches().

02341 {
02342    int matches = 0, i = 0;
02343    char *buf = NULL, *oldbuf = NULL;
02344 
02345    while ((buf = ast_cli_generator(text, word, i++))) {
02346       if (!oldbuf || strcmp(buf,oldbuf))
02347          matches++;
02348       if (oldbuf)
02349          ast_free(oldbuf);
02350       oldbuf = buf;
02351    }
02352    if (oldbuf)
02353       ast_free(oldbuf);
02354    return matches;
02355 }

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 2160 of file cli.c.

References __ast_cli_register().

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

02161 {
02162    return __ast_cli_register(e, NULL);
02163 }

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 2168 of file cli.c.

References ast_cli_register().

Referenced by __ast_mm_init_phase_2(), __ast_register_translator(), __init_manager(), ast_ais_clm_load_module(), ast_ais_evt_load_module(), ast_aoc_cli_init(), ast_builtins_init(), ast_cc_init(), ast_channels_init(), ast_data_init(), ast_event_init(), ast_features_init(), ast_file_init(), ast_http_init(), ast_image_init(), ast_indications_init(), ast_stun_init(), ast_test_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().

02169 {
02170    int i, res = 0;
02171 
02172    for (i = 0; i < len; i++)
02173       res |= ast_cli_register(e + i);
02174 
02175    return res;
02176 }

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 2154 of file cli.c.

References __ast_cli_unregister().

Referenced by alias_unregister_cb(), ast_cel_engine_term(), ast_cli_unregister_multiple(), cdr_engine_shutdown(), dnsmgr_shutdown(), do_reload(), load_module(), and unload_module().

02155 {
02156    return __ast_cli_unregister(e, NULL);
02157 }

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 2178 of file cli.c.

References ast_cli_unregister().

Referenced by __unload_module(), aoc_shutdown(), ast_ais_clm_unload_module(), astdb_shutdown(), astobj2_cleanup(), cc_shutdown(), channels_shutdown(), cli_shutdown(), close_logger(), config_shutdown(), data_shutdown(), event_shutdown(), features_shutdown(), file_shutdown(), framer_shutdown(), http_shutdown(), iax_provision_unload(), image_shutdown(), indications_shutdown(), load_module(), main_atexit(), manager_shutdown(), mm_atexit_ast(), stun_shutdown(), timing_shutdown(), tps_shutdown(), udptl_shutdown(), unload_module(), and unload_pbx().

02179 {
02180    int i, res = 0;
02181 
02182    for (i = 0; i < len; i++)
02183       res |= ast_cli_unregister(e + i);
02184 
02185    return res;
02186 }

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 1548 of file cli.c.

References ast_channel_iterator_all_new(), ast_channel_iterator_by_name_new(), ast_channel_iterator_destroy(), ast_channel_iterator_next(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, ast_strdup, and ast_strlen_zero().

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().

01549 {
01550    struct ast_channel *c = NULL;
01551    int which = 0;
01552    char notfound = '\0';
01553    char *ret = &notfound; /* so NULL can break the loop */
01554    struct ast_channel_iterator *iter;
01555 
01556    if (pos != rpos) {
01557       return NULL;
01558    }
01559 
01560    if (ast_strlen_zero(word)) {
01561       iter = ast_channel_iterator_all_new();
01562    } else {
01563       iter = ast_channel_iterator_by_name_new(word, strlen(word));
01564    }
01565 
01566    if (!iter) {
01567       return NULL;
01568    }
01569 
01570    while (ret == &notfound && (c = ast_channel_iterator_next(iter))) {
01571       if (++which > state) {
01572          ast_channel_lock(c);
01573          ret = ast_strdup(c->name);
01574          ast_channel_unlock(c);
01575       }
01576       ast_channel_unref(c);
01577    }
01578 
01579    ast_channel_iterator_destroy(iter);
01580 
01581    return ret == &notfound ? NULL : ret;
01582 }

Asterisk developer's documentation

cli.h File Reference

Data Structures

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation