Sat Mar 10 01:55:57 2012

Asterisk developer's documentation


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);)

Data Fields

const char * action
int authority
enum ast_doc_src docsrc
int(* func )(struct mansession *s, const struct message *m)
struct {
   manager_action *   next
list
unsigned int registered:1
 TRUE if the AMI action is registered and the callback can be called.


Detailed Description

Definition at line 137 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);   ) 


Field Documentation

const char* action

Name of the action

Definition at line 139 of file manager.h.

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

int authority

Permission required for action. EVENT_FLAG_*

Definition at line 148 of file manager.h.

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

enum ast_doc_src docsrc

Where the documentation come from.

Definition at line 152 of file manager.h.

Referenced by handle_showmancmd().

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

Function to be called

Referenced by process_message().

struct { ... } list

For easy linking

Referenced by action_find(), ast_manager_register_hook(), and ast_manager_unregister_hook().

struct manager_action* next

Definition at line 154 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 161 of file manager.h.

Referenced by ast_manager_register_struct(), and process_message().


The documentation for this struct was generated from the following file:
Generated on Sat Mar 10 01:55:57 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7