manager_action Struct Reference

#include <manager.h>

Collaboration diagram for manager_action:

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_item *	final_response
int(*	func )(struct mansession *s, const struct message *m)
struct ast_xml_doc_item *	list_responses
struct ast_module *	module
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()

AST_LIST_ENTRY

(

manager_action

)

For easy linking

Field Documentation

__field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 163 of file manager.h.

__field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Definition at line 163 of file manager.h.

action

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

arguments

const ast_string_field arguments

Definition at line 163 of file manager.h.

Referenced by handle_showmancmd().

authority

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 169 of file manager.h.

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

description

const ast_string_field description

Definition at line 163 of file manager.h.

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

docsrc

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 174 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 167 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 171 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 165 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 172 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 unregistering the AMI action object.

Definition at line 183 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

Definition at line 163 of file manager.h.

Referenced by handle_showmancmd().

synopsis

const ast_string_field synopsis

Definition at line 163 of file manager.h.

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

syntax

const ast_string_field syntax

Definition at line 163 of file manager.h.

Referenced by handle_showmancmd().

---

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

• manager.h