manager_action Struct Reference

#include <manager.h>

Public Member Functions
	AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(synopsis);AST_STRING_FIELD(description);AST_STRING_FIELD(syntax);AST_STRING_FIELD(arguments);AST_STRING_FIELD(seealso);)
	AST_LIST_ENTRY (manager_action) list
Data Fields
const char *	action
unsigned int	active_count
int	authority
enum ast_doc_src	docsrc
int(*	func )(struct mansession *s, const struct message *m)
unsigned int	registered:1
	TRUE if the AMI action is registered and the callback can be called.

---

Detailed Description

Definition at line 138 of file manager.h.

---

Member Function Documentation

AST_DECLARE_STRING_FIELDS

(

AST_STRING_FIELD(synopsis);AST_STRING_FIELD(description);AST_STRING_FIELD(syntax);AST_STRING_FIELD(arguments);AST_STRING_FIELD(seealso);

)

AST_LIST_ENTRY

(

manager_action

)

For easy linking

---

Field Documentation

const char* action

Name of the action

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

unsigned int active_count

Number of active func() calls in progress.

Definition at line 164 of file manager.h.

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

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 149 of file manager.h.

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

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 153 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 151 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 162 of file manager.h.

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

---

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

• manager.h