ChanAssistList Class Reference
#include <yatepbx.h>
List of all members.
Detailed Description
Class keeping a list of
ChanAssist objects. It also serves as base to implement channel assisting plugins.
Member Enumeration Documentation
Constructor & Destructor Documentation
ChanAssistList |
( |
const char * |
name, |
|
|
bool |
earlyInit = false | |
|
) |
| | [inline, protected] |
Constructor
- Parameters:
-
| name | Name of the module |
| earlyInit | True to attempt to initialize module before others |
Member Function Documentation
virtual bool received |
( |
Message & |
msg, |
|
|
int |
id | |
|
) |
| | [virtual] |
Message handler called internally
- Parameters:
-
| msg | Received nessage |
| id | Numeric identifier of the message type |
- Returns:
- True if the message was handled and further processing should stop
Reimplemented from Module.
Message handler for an assistant object
- Parameters:
-
| msg | Received nessage |
| id | Numeric identifier of the message type |
| assist | Pointer to the matching assistant object |
- Returns:
- True if the message was handled and further processing should stop
virtual void initialize |
( |
|
) |
[virtual] |
Method to (re)initialize the plugin
Reimplemented from Module.
Create a new channel assistant
- Parameters:
-
| msg | Message that triggered the creation |
| id | Channel's identifier |
- Returns:
- Pointer to new assistant object, NULL if unacceptable
virtual void init |
( |
int |
priority = 15 |
) |
[virtual] |
Initialize the plugin for the first time
- Parameters:
-
| priority | Priority used to install message handlers |
Find a channel assistant by channel ID
- Parameters:
-
| id | Identifier of the assisted channel |
- Returns:
- Pointer to the assistant object
void removeAssist |
( |
ChanAssist * |
assist |
) |
[protected] |
Removes an assistant object from list
- Parameters:
-
| assist | Object to remove from list |
The documentation for this class was generated from the following file: