Thu Apr 16 06:48:16 2015

Asterisk developer's documentation


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

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

const int dead

Does this application run dead

Definition at line 52 of file agi.h.

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

Where the documentation come from.

Definition at line 58 of file agi.h.

Referenced by ast_agi_unregister(), and handle_cli_agi_show().

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

Referenced by agi_handle_command().

struct { ... } list

Linked list pointer

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

struct ast_module* mod [read]

Pointer to module that registered the agi command

Definition at line 60 of file agi.h.

Referenced by agi_handle_command(), ast_agi_register_multiple(), ast_agi_unregister(), and ast_agi_unregister_multiple().

struct agi_command* next [read]

Definition at line 62 of file agi.h.

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

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

const char* const syntax

AGI command syntax description

Definition at line 54 of file agi.h.

Referenced by ast_agi_unregister(), and handle_cli_agi_show().

const char* const usage

Detailed usage information

Definition at line 50 of file agi.h.

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


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

Generated on Thu Apr 16 06:48:16 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6