ChanAssist Class Reference
#include <yatepbx.h>
List of all members.
Detailed Description
Object that assists a channel
Constructor & Destructor Documentation
Constructor of base class
- Parameters:
-
| list | ChanAssistList that owns this object |
| id | Identifier of the assisted channel |
Member Function Documentation
const String& id |
( |
|
) |
const [inline] |
Get the name of the assisted channel
- Returns:
- Identifier of the channel
Retrive the list that owns this object
- Returns:
- Pointer to the owner list
Retrive a smart pointer to an arbitrary channel
- Parameters:
-
| id | Identifier of the channel to locate |
- Returns:
- Smart pointer to the channel or NULL if not found or dead
virtual bool msgDisconnect |
( |
Message & |
msg, |
|
|
const String & |
reason | |
|
) |
| | [virtual] |
Process the channel disconnect message, may connect to something else
- Parameters:
-
| msg | The chan.disconnected message |
| reason | The disconnection reason |
virtual void msgExecute |
( |
Message & |
msg |
) |
[virtual] |
Process the call.execute message, copy any parameters needed later
- Parameters:
-
| msg | Call execute message, may be received before chan.startup |
virtual void msgHangup |
( |
Message & |
msg |
) |
[virtual] |
Process the chan.hangup message
- Parameters:
-
virtual void msgStartup |
( |
Message & |
msg |
) |
[virtual] |
Process the chan.startup message
- Parameters:
-
| msg | First channel message, may be received after call.execute |
virtual const String& toString |
( |
|
) |
const [inline, virtual] |
Get the String value of this object
- Returns:
- ID of the assisted channel
Reimplemented from GenObject.
The documentation for this class was generated from the following file: