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.

#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_users(), _sip_show_peer(), sip_show_user(), sip_show_settings(), sip_show_mwi(), show_channels_cb(), sip_show_channel(), handle_skinny_show_settings(), handle_feature_show(), action_coresettings(), and handle_manager_show_settings().

#define AST_MAX_ARGS 64

Definition at line 49 of file cli.h.

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

#define AST_MAX_CMD_LEN 16

Definition at line 47 of file cli.h.

Referenced by find_best(), and __ast_cli_register().

#define CLI_FAILURE (char *)RESULT_FAILURE

Definition at line 45 of file cli.h.

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

#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 handle_cli_status(), sip_show_channels(), print_uptimestr(), handle_showcalls(), handle_chanlist(), group_show_channels(), handle_parkedcalls(), cli_realtime_update(), cli_realtime_update2(), and cli_realtime_destroy().

#define RESULT_SHOWUSAGE 1

Definition at line 40 of file cli.h.

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

#define RESULT_SUCCESS 0

Definition at line 39 of file cli.h.

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

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.

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

Function Documentation

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

Definition at line 102 of file cli.c.

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

{
   int res;
   struct ast_str *buf;
   va_list ap;

   if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN)))
      return;

   va_start(ap, fmt);
   res = ast_str_set_va(&buf, 0, fmt, ap);
   va_end(ap);

   if (res != AST_DYNSTR_BUILD_FAILED) {
      ast_carefulwrite(fd, ast_str_buffer(buf), ast_str_strlen(buf), 100);
   }
}

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

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

Referenced by ast_cli_command_multiple_full().

{
   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);
done:
   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 2503 of file cli.c.

References ast_cli_command_full().

Referenced by netconsole().

{
   char cmd[512];
   int x, y = 0, count = 0;

   for (x = 0; x < size; x++) {
      cmd[y] = s[x];
      y++;
      if (s[x] == '\0') {
         ast_cli_command_full(uid, gid, fd, cmd);
         y = 0;
         count++;
      }
   }
   return count;
}

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

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

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

{
   int i, which = 0, len;
   len = ast_strlen_zero(word) ? 0 : strlen(word);

   for (i = 0; choices[i]; i++) {
      if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state)
         return ast_strdup(choices[i]);
   }
   return NULL;
}

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

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

Referenced by cli_complete(), and handle_commandmatchesarray().

{
   char **match_list = NULL, *retstr, *prevstr;
   size_t match_list_len, max_equal, which, i;
   int matches = 0;

   /* leave entry 0 free for the longest common substring */
   match_list_len = 1;
   while ((retstr = ast_cli_generator(text, word, matches)) != NULL) {
      if (matches + 1 >= match_list_len) {
         match_list_len <<= 1;
         if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list))))
            return NULL;
      }
      match_list[++matches] = retstr;
   }

   if (!match_list)
      return match_list; /* NULL */

   /* Find the longest substring that is common to all results
    * (it is a candidate for completion), and store a copy in entry 0.
    */
   prevstr = match_list[1];
   max_equal = strlen(prevstr);
   for (which = 2; which <= matches; which++) {
      for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++)
         continue;
      max_equal = i;
   }

   if (!(retstr = ast_malloc(max_equal + 1)))
      return NULL;
   
   ast_copy_string(retstr, match_list[1], max_equal + 1);
   match_list[0] = retstr;

   /* ensure that the array is NULL terminated */
   if (matches + 1 >= match_list_len) {
      if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list))))
         return NULL;
   }
   match_list[matches + 1] = NULL;

   return match_list;
}

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

References __ast_cli_generator().

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

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

int ast_cli_generatornummatches	(	const char *	,
		const char *
	)

Return the number of unique matches for the generator.

Definition at line 2282 of file cli.c.

References ast_cli_generator(), and ast_free.

Referenced by handle_commandnummatches().

{
   int matches = 0, i = 0;
   char *buf = NULL, *oldbuf = NULL;

   while ((buf = ast_cli_generator(text, word, i++))) {
      if (!oldbuf || strcmp(buf,oldbuf))
         matches++;
      if (oldbuf)
         ast_free(oldbuf);
      oldbuf = buf;
   }
   if (oldbuf)
      ast_free(oldbuf);
   return matches;
}

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

References __ast_cli_register().

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

{
   return __ast_cli_register(e, NULL);
}

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

References len(), and ast_cli_register().

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

{
   int i, res = 0;

   for (i = 0; i < len; i++)
      res |= ast_cli_register(e + i);

   return res;
}

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

References __ast_cli_unregister().

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

{
   return __ast_cli_unregister(e, NULL);
}

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

References len(), and ast_cli_unregister().

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

{
   int i, res = 0;

   for (i = 0; i < len; i++)
      res |= ast_cli_unregister(e + i);

   return res;
}

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

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

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

{
   struct ast_channel *c = NULL;
   int which = 0;
   char notfound = '\0';
   char *ret = &notfound; /* so NULL can break the loop */
   struct ast_channel_iterator *iter;

   if (pos != rpos) {
      return NULL;
   }

   if (ast_strlen_zero(word)) {
      iter = ast_channel_iterator_all_new();
   } else {
      iter = ast_channel_iterator_by_name_new(word, strlen(word));
   }

   if (!iter) {
      return NULL;
   }

   while (ret == &notfound && (c = ast_channel_iterator_next(iter))) {
      if (++which > state) {
         ast_channel_lock(c);
         ret = ast_strdup(c->name);
         ast_channel_unlock(c);
      }
      ast_channel_unref(c);
   }

   ast_channel_iterator_destroy(iter);

   return ret == &notfound ? NULL : ret;
}

Asterisk developer's documentation

Data Structures

Defines

Enumerations

Functions

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation