Asterisk - The Open Source Telephony Project  GIT-master-44aef04
Public Member Functions | Data Fields
manager_action Struct Reference

#include <manager.h>

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 149 of file manager.h.

Member Function Documentation

◆ AST_LIST_ENTRY()

AST_LIST_ENTRY ( manager_action  )

For easy linking

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 158 of file manager.h.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Definition at line 158 of file manager.h.

◆ action

const char* action

◆ arguments

const ast_string_field arguments

Description of each argument.

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().

◆ authority

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

◆ description

const ast_string_field description

Description (help text)

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd(), Parameter::load(), Api::load(), Property::load(), Model::load(), and ResourceApi::load().

◆ docsrc

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 169 of file manager.h.

Referenced by ast_manager_register2(), and handle_showmancmd().

◆ final_response

struct ast_xml_doc_item* final_response

Final response event.

Definition at line 162 of file manager.h.

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

◆ func

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

Function to be called

Definition at line 166 of file manager.h.

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

◆ list_responses

struct ast_xml_doc_item* list_responses

Possible list element response events.

Definition at line 160 of file manager.h.

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

◆ module

struct ast_module* module

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

◆ registered

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

◆ seealso

const ast_string_field seealso

See also

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().

◆ synopsis

const ast_string_field synopsis

Synopsis text (short description).

Definition at line 158 of file manager.h.

Referenced by action_destroy(), action_listcommands(), handle_showmancmd(), and handle_showmancmds().

◆ syntax

const ast_string_field syntax

Syntax text

Definition at line 158 of file manager.h.

Referenced by handle_showmancmd().


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