Asterisk - The Open Source Telephony Project  21.4.1
Data Fields
ast_cli_entry Struct Reference

descriptor for a cli entry. More...

#include <cli.h>

Data Fields

char * _full_cmd
 
int args
 This gets set in ast_cli_register() More...
 
const char *const cmda [AST_MAX_CMD_LEN]
 
int cmdlen
 
char * command
 
char *(* handler )(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
int inuse
 
struct {
   struct ast_cli_entry *   next
 
list
 
struct ast_modulemodule
 
const char *const summary
 
const char * usage
 

Detailed Description

descriptor for a cli entry.

Examples:
app_skel.c.

Definition at line 171 of file cli.h.

Field Documentation

char* _full_cmd

built at load time from cmda[]

Definition at line 181 of file cli.h.

Referenced by ast_cli_unregister(), handle_cli_check_permissions(), help1(), and set_full_cmd().

int args
const char* const cmda[AST_MAX_CMD_LEN]

words making up the command. set the first entry to NULL for a new-style entry.

Definition at line 172 of file cli.h.

Referenced by ast_cli_unregister(), and set_full_cmd().

int cmdlen

len up to the first invalid char [<{%

Definition at line 182 of file cli.h.

Referenced by set_full_cmd().

char* command

command, non-null for new-style entries

Examples:
app_skel.c.

Definition at line 186 of file cli.h.

Referenced by alias_cmp_cb(), alias_hash_cb(), alias_show(), alias_unregister_cb(), ast_cli_unregister(), cli_alias_passthrough(), cli_console_answer(), cli_console_sendtext(), cli_fax_set_debug(), cli_fax_show_capabilities(), cli_fax_show_session(), cli_fax_show_sessions(), cli_fax_show_settings(), cli_fax_show_stats(), handle_cdr_pgsql_status(), handle_cli_agi_add_cmd(), handle_cli_check_permissions(), handle_cli_core_show_channeltype(), handle_cli_core_show_channeltypes(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_add_ignorepat(), handle_cli_dialplan_add_include(), handle_cli_dialplan_remove_context(), handle_cli_dialplan_remove_extension(), handle_cli_dialplan_remove_include(), handle_cli_dialplan_save(), handle_cli_file_convert(), handle_cli_iax2_set_mtu(), handle_cli_iax2_show_peer(), handle_cli_keys_init(), handle_cli_keys_show(), handle_cli_reload_permissions(), handle_cli_show_permissions(), handle_cli_sound_show(), handle_cli_sounds_show(), handle_debug_dialplan(), handle_eval_function(), handle_exec(), handle_kickmanconn(), handle_logger_show_channels(), handle_logger_show_levels(), handle_manager_reload(), handle_manager_show_settings(), handle_minivm_list_templates(), handle_minivm_reload(), handle_minivm_show_settings(), handle_minivm_show_stats(), handle_minivm_show_users(), handle_minivm_show_zones(), handle_orig(), handle_redirect(), handle_show_application(), handle_show_calendars(), handle_show_calendars_types(), handle_show_chanvar(), handle_show_globals(), handle_show_hangup_all(), handle_show_hangup_channel(), handle_show_hint(), handle_show_hints(), handle_show_named_acl_cmd(), handle_show_parking_lot_cmd(), handle_show_settings(), handle_show_switches(), handle_show_sysinfo(), handle_showchan(), handle_showmancmds(), handle_showmanconn(), handle_showmaneventq(), handle_voicemail_reload(), handle_voicemail_show_aliases(), handle_voicemail_show_users(), handle_voicemail_show_zones(), load_config(), locals_show(), realtime_ldap_status(), set_config(), unistim_reload(), xmpp_cli_create_collection(), xmpp_cli_create_leafnode(), xmpp_cli_delete_pubsub_node(), xmpp_cli_list_pubsub_nodes(), and xmpp_cli_purge_pubsub_nodes().

int inuse

For keeping track of usage

Definition at line 179 of file cli.h.

Referenced by ast_cli_command_full(), and ast_cli_unregister().

struct { ... } list

For linking

struct ast_module* module

module this belongs to

Definition at line 180 of file cli.h.

Referenced by ast_cli_command_full().

const char* const summary

Summary of the command (< 60 characters)

Definition at line 176 of file cli.h.

Referenced by handle_cli_check_permissions(), and help1().

const char* usage

Detailed usage information

Examples:
app_skel.c.

Definition at line 177 of file cli.h.

Referenced by alias_show(), ast_cli_command_full(), ast_cli_unregister(), cli_console_answer(), cli_console_sendtext(), cli_fax_set_debug(), cli_fax_show_capabilities(), cli_fax_show_session(), cli_fax_show_sessions(), cli_fax_show_settings(), cli_fax_show_stats(), handle_cdr_pgsql_status(), handle_cli_agi_add_cmd(), handle_cli_check_permissions(), handle_cli_core_show_channeltype(), handle_cli_core_show_channeltypes(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_add_ignorepat(), handle_cli_dialplan_add_include(), handle_cli_dialplan_remove_context(), handle_cli_dialplan_remove_extension(), handle_cli_dialplan_remove_include(), handle_cli_dialplan_save(), handle_cli_file_convert(), handle_cli_iax2_set_mtu(), handle_cli_iax2_show_peer(), handle_cli_keys_init(), handle_cli_keys_show(), handle_cli_reload_permissions(), handle_cli_show_permissions(), handle_cli_sound_show(), handle_cli_sounds_show(), handle_debug_dialplan(), handle_eval_function(), handle_exec(), handle_kickmanconn(), handle_logger_show_channels(), handle_logger_show_levels(), handle_manager_reload(), handle_manager_show_settings(), handle_minivm_list_templates(), handle_minivm_reload(), handle_minivm_show_settings(), handle_minivm_show_stats(), handle_minivm_show_users(), handle_minivm_show_zones(), handle_orig(), handle_redirect(), handle_show_application(), handle_show_calendars(), handle_show_calendars_types(), handle_show_chanvar(), handle_show_globals(), handle_show_hangup_all(), handle_show_hangup_channel(), handle_show_hint(), handle_show_hints(), handle_show_named_acl_cmd(), handle_show_parking_lot_cmd(), handle_show_settings(), handle_show_switches(), handle_show_sysinfo(), handle_showchan(), handle_showmancmds(), handle_showmanconn(), handle_showmaneventq(), handle_voicemail_reload(), handle_voicemail_show_aliases(), handle_voicemail_show_users(), handle_voicemail_show_zones(), load_config(), locals_show(), realtime_ldap_status(), set_config(), unistim_reload(), xmpp_cli_create_collection(), xmpp_cli_create_leafnode(), xmpp_cli_delete_pubsub_node(), xmpp_cli_list_pubsub_nodes(), and xmpp_cli_purge_pubsub_nodes().


The documentation for this struct was generated from the following file: