manager_action Struct Reference

#include <manager.h>

Collaboration diagram for manager_action:

Collaboration graph
[legend]

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_item * final_response
int(* func )(struct mansession *s, const struct message *m)
struct {
   struct manager_action *   next
list
struct ast_xml_doc_item * list_responses
struct ast_modulemodule
unsigned int registered:1
 TRUE if the AMI action is registered and the callback can be called.
const ast_string_field seealso
const ast_string_field synopsis
const ast_string_field syntax

Detailed Description

Definition at line 149 of file manager.h.


Field Documentation

Definition at line 158 of file manager.h.

Definition at line 158 of file manager.h.

const char* action

Name of the action Synopsis text (short description). Description (help text) Syntax text Description of each argument. See also

Definition at line 153 of file manager.h.

Referenced by action_find(), action_listcommands(), ast_manager_register2(), ast_manager_register_struct(), ast_manager_unregister(), handle_showmancmd(), handle_showmancmds(), and process_message().

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 164 of file manager.h.

Referenced by action_listcommands(), ast_manager_register2(), handle_showmancmd(), and process_message().

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().

Where the documentation come from.

Definition at line 169 of file manager.h.

Referenced by ast_manager_register2(), and handle_showmancmd().

struct ast_xml_doc_item* final_response [read]

Final response event.

Definition at line 162 of file manager.h.

Referenced by action_destroy(), ast_manager_register2(), and handle_showmancmd().

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

Function to be called

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

struct { ... } list

For easy linking

Referenced by handle_showmancmds().

struct ast_xml_doc_item* list_responses [read]

Possible list element response events.

Definition at line 160 of file manager.h.

Referenced by action_destroy(), ast_manager_register2(), and handle_showmancmd().

struct ast_module* module [read]

Module this action belongs to

Definition at line 167 of file manager.h.

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

struct manager_action* next [read]

Definition at line 171 of file manager.h.

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 unregestring the AMI action object.

Definition at line 178 of file manager.h.

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

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().


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

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