Asterisk - The Open Source Telephony Project  21.4.1
Public Member Functions | Data Fields
manager_action Struct Reference

Public Member Functions

 AST_LIST_ENTRY (manager_action) list
 

Data Fields

struct ast_string_field_mgr __field_mgr
 
struct ast_string_field_pool__field_mgr_pool
 
const char * action
 
const ast_string_field arguments
 
int authority
 
const ast_string_field description
 
enum ast_doc_src docsrc
 
struct ast_xml_doc_itemfinal_response
 
int(* func )(struct mansession *s, const struct message *m)
 
struct ast_xml_doc_itemlist_responses
 
struct ast_modulemodule
 
unsigned int registered:1
 TRUE if the AMI action is registered and the callback can be called. More...
 
const ast_string_field seealso
 
const ast_string_field synopsis
 
const ast_string_field syntax
 

Detailed Description

Definition at line 154 of file manager.h.

Member Function Documentation

AST_LIST_ENTRY ( manager_action  )

For easy linking

Field Documentation

const char* action

Name of the action

Definition at line 156 of file manager.h.

Referenced by ast_manager_register2(), ast_manager_unregister(), handle_showmancmds(), and process_message().

const ast_string_field arguments

Description of each argument.

Definition at line 163 of file manager.h.

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 169 of file manager.h.

Referenced by ast_manager_register2(), and process_message().

const ast_string_field description

Description (help text)

Definition at line 163 of file manager.h.

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 174 of file manager.h.

Referenced by ast_manager_register2().

struct ast_xml_doc_item* final_response

Final response event.

Definition at line 167 of file manager.h.

Referenced by ast_manager_register2().

int(* func) (struct mansession *s, const struct message *m)

Function to be called

Definition at line 171 of file manager.h.

Referenced by ast_hook_send_action(), ast_manager_register2(), and process_message().

struct ast_xml_doc_item* list_responses

Possible list element response events.

Definition at line 165 of file manager.h.

Referenced by ast_manager_register2().

struct ast_module* module

Module this action belongs to

Definition at line 172 of file manager.h.

Referenced by ast_hook_send_action(), ast_manager_register2(), and process_message().

unsigned int registered

TRUE if the AMI action is registered and the callback can be called.

Note
Needed to prevent a race between calling the callback function and unregistering the AMI action object.

Definition at line 183 of file manager.h.

Referenced by ast_hook_send_action(), ast_manager_unregister(), and process_message().

const ast_string_field seealso

See also

Definition at line 163 of file manager.h.

const ast_string_field synopsis

Synopsis text (short description).

Definition at line 163 of file manager.h.

Referenced by handle_showmancmds().

const ast_string_field syntax

Syntax text

Definition at line 163 of file manager.h.


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