Yate
|
Base Driver with client specific functions. More...
#include <yatecbase.h>
Public Member Functions | |
virtual void | initialize ()=0 |
virtual bool | msgExecute (Message &msg, String &dest) |
virtual void | msgTimer (Message &msg) |
virtual bool | msgRoute (Message &msg) |
virtual bool | received (Message &msg, int id) |
const String & | activeId () const |
bool | setActive (const String &id=String::empty()) |
ClientChannel * | findLine (int line) |
Static Public Member Functions | |
static ClientDriver * | self () |
static const String & | device () |
static void | dropCalls (const char *reason=0) |
static bool | setAudioTransfer (const String &id, const String &target=String::empty()) |
static bool | setConference (const String &id, bool in, const String *confName=0, bool buildFromChan=false) |
static ClientChannel * | findChan (const String &id) |
static ClientChannel * | findChanByPeer (const String &peer) |
static ClientChannel * | findActiveChan () |
static void | dropChan (const String &chan, const char *reason=0, bool peer=false) |
Static Public Attributes | |
static String | s_confName |
static bool | s_dropConfPeer |
Protected Member Functions | |
void | setup () |
Protected Attributes | |
String | m_activeId |
Static Protected Attributes | |
static ClientDriver * | s_driver |
static String | s_device |
Friends | |
class | ClientChannel |
Base Driver with client specific functions.
Abstract client Driver that implements some of the specific functionality
Get the active channel's id
Get the current audio device's name
static void dropCalls | ( | const char * | reason = 0 | ) | [static] |
Drop all calls belonging to the active driver
reason | Optional drop reason |
Drop a channel
chan | Channel id |
reason | Optional reason |
peer | Set it to true to drop a client channel peer used to reconnect |
static ClientChannel* findActiveChan | ( | ) | [inline, static] |
Get the active channel
static ClientChannel* findChan | ( | const String & | id | ) | [static] |
Get a referenced channel found by its id
id | The id of the channel to find |
static ClientChannel* findChanByPeer | ( | const String & | peer | ) | [static] |
Get a referenced channel whose stored peer is the given one
peer | Peer id to check |
ClientChannel* findLine | ( | int | line | ) |
virtual void initialize | ( | ) | [pure virtual] |
This method is called to initialize the loaded module
Reimplemented from Driver.
virtual bool msgExecute | ( | Message & | msg, |
String & | dest | ||
) | [virtual] |
Create an outgoing calling channel
msg | Call execute message |
dest | Destination of the new call |
Implements Driver.
Routing message handler. The default implementation routes to this driver if it owns a line named in the "account" or "line" parameter.
msg | Call routing message |
Reimplemented from Driver.
static ClientDriver* self | ( | ) | [inline, static] |
Get the global client driver object's address
bool setActive | ( | const String & | id = String::empty() | ) |
Set/reset the active channel. Does nothing if the selected channel is the active one. Put the active channel on hold before trying to set the active channel
id | The new active channel's id. Set to empty if don't want to set a new active channel |
static bool setAudioTransfer | ( | const String & | id, |
const String & | target = String::empty() |
||
) | [static] |
Attach/detach client channels peers' source/consumer
id | The id of the channel to tranfer |
target | The transfer target. Leave blank to reset the channel's transfer id |
static bool setConference | ( | const String & | id, |
bool | in, | ||
const String * | confName = 0 , |
||
bool | buildFromChan = false |
||
) | [static] |
Attach/detach a client channel to/from a conference room
id | The id of the channel to process |
in | True to enter the conference room, false to exit from it |
confName | Optional id of the conference. Set to 0 to use the default one Ignored if 'in' is false |
buildFromChan | Build conference name from channel id if true |
String s_confName [static] |
The name to use when the client is in conference
bool s_dropConfPeer [static] |
Indicates wether a channel should drop its former peer when terminated while in conference