Asterisk - The Open Source Telephony Project GIT-master-f3e88d3
Data Fields
agi_command Struct Reference

#include <agi.h>

Collaboration diagram for agi_command:
Collaboration graph
[legend]

Data Fields

const char *const cmda [AST_MAX_CMD_LEN]
 
const int dead
 
enum ast_doc_src docsrc
 
int(*const handler )(struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
struct {
   struct agi_command *   next
 
list
 
struct ast_modulemod
 
const char *const seealso
 
const char *const summary
 
const char *const syntax
 
const char *const usage
 

Detailed Description

Definition at line 42 of file agi.h.

Field Documentation

◆ cmda

const char* const cmda[AST_MAX_CMD_LEN]

Null terminated list of the words of the command

Definition at line 43 of file agi.h.

Referenced by find_command(), help_workhorse(), and write_htmldump().

◆ dead

const int dead

Does this application run dead

Definition at line 52 of file agi.h.

Referenced by agi_exec_full(), agi_handle_command(), handle_cli_agi_show(), and help_workhorse().

◆ docsrc

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 58 of file agi.h.

Referenced by ast_agi_unregister(), and handle_cli_agi_show().

◆ handler

int(*const handler) (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])

Handler for the command (channel, AGI state, # of arguments, argument list). Returns RESULT_SHOWUSAGE for improper arguments

Definition at line 46 of file agi.h.

◆ 

struct { ... } list

Linked list pointer

Referenced by ast_agi_unregister(), find_command(), help_workhorse(), and write_htmldump().

◆ mod

struct ast_module* mod

Pointer to module that registered the agi command

Definition at line 60 of file agi.h.

Referenced by ast_agi_register_multiple().

◆ next

struct agi_command* next

Definition at line 62 of file agi.h.

◆ seealso

const char* const seealso

See also content

Definition at line 56 of file agi.h.

Referenced by ast_agi_unregister(), and handle_cli_agi_show().

◆ summary

const char* const summary

Summary of the command (< 60 characters)

Definition at line 48 of file agi.h.

Referenced by ast_agi_unregister(), handle_cli_agi_show(), help_workhorse(), and write_htmldump().

◆ syntax

const char* const syntax

AGI command syntax description

Definition at line 54 of file agi.h.

Referenced by ast_agi_unregister(), AST_TEST_DEFINE(), and handle_cli_agi_show().

◆ usage

const char* const usage

Detailed usage information

Definition at line 50 of file agi.h.

Referenced by ast_agi_unregister(), AST_TEST_DEFINE(), handle_cli_agi_show(), and write_htmldump().


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