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
int(*	func )(struct mansession *s, const struct message *m)
struct ast_module *	module
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 140 of file manager.h.

---

Member Function Documentation

AST_LIST_ENTRY

(

manager_action

)

For easy linking

---

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 149 of file manager.h.

struct ast_string_field_pool* __field_mgr_pool

Definition at line 149 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 144 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().

const ast_string_field arguments

Definition at line 149 of file manager.h.

Referenced by handle_showmancmd().

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 151 of file manager.h.

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

const ast_string_field description

Definition at line 149 of file manager.h.

Referenced by handle_showmancmd().

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 156 of file manager.h.

Referenced by ast_manager_register2(), and handle_showmancmd().

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

Function to be called

Definition at line 153 of file manager.h.

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

struct ast_module* module

Module this action belongs to

Definition at line 154 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 unregestring the AMI action object.

Definition at line 165 of file manager.h.

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

const ast_string_field seealso

Definition at line 149 of file manager.h.

Referenced by handle_showmancmd().

const ast_string_field synopsis

Definition at line 149 of file manager.h.

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

const ast_string_field syntax

Definition at line 149 of file manager.h.

Referenced by handle_showmancmd().

---

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

• manager.h