Yate
|
Channel used by client programs. More...
#include <yatecbase.h>
Public Types | |
enum | Notification { Startup, Destroyed, Active, OnHold, Mute, Noticed, AddrChanged, Routed, Accepted, Rejected, Progressing, Ringing, Answered, Transfer, Conference, AudioSet, Unknown } |
enum | SlaveType { SlaveNone = 0, SlaveTransfer, SlaveConference } |
Public Member Functions | |
ClientChannel (const Message &msg, const String &peerid) | |
ClientChannel (const String &target, const NamedList ¶ms, int st=SlaveNone, const String &masterChan=String::empty()) | |
ClientChannel (const String &soundId) | |
bool | start (const String &target, const NamedList ¶ms) |
virtual bool | msgProgress (Message &msg) |
virtual bool | msgRinging (Message &msg) |
virtual bool | msgAnswered (Message &msg) |
virtual bool | msgDrop (Message &msg, const char *reason) |
virtual bool | callRouted (Message &msg) |
virtual void | callAccept (Message &msg) |
virtual void | callRejected (const char *error, const char *reason, const Message *msg) |
void | callAnswer (bool setActive=true) |
int | slave () const |
ObjList & | slaves () |
unsigned int | slavesCount () const |
void | addSlave (const String &sid) |
void | removeSlave (const String &sid) |
const String & | master () const |
const NamedList & | clientParams () const |
const String & | party () const |
const String & | partyName () const |
bool | conference () const |
const String & | transferId () const |
RefObject * | clientData () const |
void | setClientData (RefObject *obj=0) |
bool | setMedia (bool open=false, bool replace=false) |
bool | setActive (bool active, bool update=true) |
bool | setMuted (bool on, bool update=true) |
void | setTransfer (const String &target=String::empty()) |
void | setConference (const String &target=String::empty()) |
const String & | peerOutFormat () const |
const String & | peerInFormat () const |
bool | active () const |
bool | muted () const |
bool | isNoticed () const |
void | noticed () |
int | line () const |
void | line (int newLine) |
void | update (int notif, bool chan=true, bool updatePeer=true, const char *engineMsg=0, bool minimal=false, bool data=false) |
void | getReconnPeer (String &buf) |
bool | hasReconnPeer () |
CallEndpoint * | getReconnPeer (bool ref=true) |
void | dropReconnPeer (const char *reason=0) |
Static Public Member Functions | |
static int | lookup (const char *notif, int def=Unknown) |
static const char * | lookup (int notif, const char *def=0) |
static int | lookupSlaveType (const char *notif, int def=SlaveNone) |
Static Public Attributes | |
static const TokenDict | s_notification [] |
static const TokenDict | s_slaveTypes [] |
Protected Member Functions | |
virtual void | destroyed () |
virtual void | connected (const char *reason) |
virtual void | disconnected (bool final, const char *reason) |
bool | peerHasSource (Message &msg) |
void | checkSilence () |
Protected Attributes | |
int | m_slave |
String | m_master |
String | m_party |
String | m_partyName |
String | m_peerOutFormat |
String | m_peerInFormat |
String | m_reason |
String | m_peerId |
bool | m_noticed |
int | m_line |
bool | m_active |
bool | m_silence |
bool | m_conference |
bool | m_muted |
String | m_transferId |
RefObject * | m_clientData |
bool | m_utility |
String | m_soundId |
ObjList | m_slaves |
NamedList | m_clientParams |
Friends | |
class | ClientDriver |
enum Notification |
Channel notifications
ClientChannel | ( | const Message & | msg, |
const String & | peerid | ||
) |
Incoming (from engine) constructor
msg | The call.execute message |
peerid | The peer's id |
ClientChannel | ( | const String & | target, |
const NamedList & | params, | ||
int | st = SlaveNone , |
||
const String & | masterChan = String::empty() |
||
) |
Outgoing (to engine) constructor
target | The target to call |
params | Call parameters |
st | Optional slave |
masterChan | Master channel id if slave, ignored otherwise |
ClientChannel | ( | const String & | soundId | ) | [explicit] |
Constructor for utility channels used to play notifications
soundId | The id of the sound to play |
bool active | ( | ) | const [inline] |
Check if this channel is the active one
Add a slave id. This method is thread safe
sid | Slave id to add |
virtual void callAccept | ( | Message & | msg | ) | [virtual] |
Notification on success of incoming call
msg | Notification call.execute message just after being dispatched |
Reimplemented from Channel.
void callAnswer | ( | bool | setActive = true | ) |
Answer an incoming call. Set media channels. Enqueue a clientchan.update message
setActive | True to activate the channel |
virtual void callRejected | ( | const char * | error, |
const char * | reason, | ||
const Message * | msg | ||
) | [virtual] |
Notification on failure of incoming call
error | Standard error keyword |
reason | Textual failure reason |
msg | Pointer to message causing the rejection, if any |
Reimplemented from Channel.
virtual bool callRouted | ( | Message & | msg | ) | [virtual] |
Notification on progress of routing incoming call
msg | Notification call.route message just after being dispatched |
Reimplemented from Channel.
RefObject* clientData | ( | ) | const [inline] |
Get the client data
const NamedList& clientParams | ( | ) | const [inline] |
Retrieve channel client parameters
bool conference | ( | ) | const [inline] |
Check if this channel is in conference
virtual void connected | ( | const char * | reason | ) | [protected, virtual] |
Connect notification method.
reason | Text that describes connect reason. |
Reimplemented from Channel.
virtual void destroyed | ( | ) | [protected, virtual] |
Destruct notification, performs cleanups
Reimplemented from CallEndpoint.
virtual void disconnected | ( | bool | final, |
const char * | reason | ||
) | [protected, virtual] |
Disconnect notification method.
final | True if this disconnect was called from the destructor. |
reason | Text that describes disconnect reason. |
Reimplemented from Channel.
void dropReconnPeer | ( | const char * | reason = 0 | ) |
Drop peer used to reconnect
void getReconnPeer | ( | String & | buf | ) | [inline] |
Retrieve peer used to reconnect. This method is thread safe
buf | Destination buffer |
CallEndpoint* getReconnPeer | ( | bool | ref = true | ) |
Get peer used to reconnect
ref | True to return a referenced pointer |
bool hasReconnPeer | ( | ) | [inline] |
Check if the peer used to reconnect is alive
bool isNoticed | ( | ) | const [inline] |
Check if this channel was noticed
int line | ( | ) | const [inline] |
Get this channel's line
void line | ( | int | newLine | ) |
Set this channel's line
newLine | This channel's line |
static int lookup | ( | const char * | notif, |
int | def = Unknown |
||
) | [inline, static] |
Lookup for a notification id
notif | The notification's name |
def | Default value to return if not found |
References TelEngine::lookup().
static const char* lookup | ( | int | notif, |
const char * | def = 0 |
||
) | [inline, static] |
Lookup for a notification name
notif | The notification's id |
def | Default value to return if not found |
References TelEngine::lookup().
static int lookupSlaveType | ( | const char * | notif, |
int | def = SlaveNone |
||
) | [inline, static] |
Lookup for a slave type
notif | The slave type name |
def | Default value to return if not found |
References TelEngine::lookup().
Get the master channel id if any
virtual bool msgAnswered | ( | Message & | msg | ) | [virtual] |
Notification on remote answered. Note that the answered flag will be set
msg | Notification message |
Reimplemented from Channel.
Notification on current call drop request
msg | Notification message |
reason | Pointer to drop reason text or NULL if none provided |
Reimplemented from Channel.
virtual bool msgProgress | ( | Message & | msg | ) | [virtual] |
Notification on remote call making some progress, not enabled by default
msg | Notification message |
Reimplemented from Channel.
virtual bool msgRinging | ( | Message & | msg | ) | [virtual] |
Notification on remote ringing
msg | Notification message |
Reimplemented from Channel.
bool muted | ( | ) | const [inline] |
Check if this channel is muted
void noticed | ( | ) |
Notice this channel. Enqueue a clientchan.update message
Get the remote party of this channel
Get the remote party name of this channel
const String& peerInFormat | ( | ) | const [inline] |
Get the peer source's data format
const String& peerOutFormat | ( | ) | const [inline] |
Get the peer consumer's data format
void removeSlave | ( | const String & | sid | ) | [inline] |
Remove a slave id. This method is thread safe
sid | Slave id to remove |
bool setActive | ( | bool | active, |
bool | update = true |
||
) |
Set/reset this channel's data source/consumer
active | True to set active, false to set inactive (mute) |
update | True to enqueue an update message |
void setClientData | ( | RefObject * | obj = 0 | ) | [inline] |
Set/reset the client data. If a new client data is set its reference counter is increased
obj | The new client data |
References TelEngine::destruct().
void setConference | ( | const String & | target = String::empty() | ) |
Set/reset the conference data. Enqueue clientchan.update if changed. Open media when reset if the channel is active and answered
target | The confeernce room's name. Leave it blank to reset |
bool setMedia | ( | bool | open = false , |
bool | replace = false |
||
) |
Attach/detach media channels
open | True to open, false to close |
replace | True to replace media if already open. Ignored if open is false |
bool setMuted | ( | bool | on, |
bool | update = true |
||
) |
Set/reset this channel's muted flag. Set media if 'on' is false and the channel is active
on | True to reset outgoing media, false to set outgoing media |
update | True to enqueue an update message |
void setTransfer | ( | const String & | target = String::empty() | ) |
Set/reset the transferred peer's id. Enqueue clientchan.update if changed. Open media when reset if the channel is active and answered
target | The transferred peer's id. Leave it blank to reset |
int slave | ( | ) | const [inline] |
Get the slave type of this channel
Retrieve channel slaves. This method is not thread safe
unsigned int slavesCount | ( | ) | const [inline] |
Retrieve channel slaves number. This method is thread safe
Init and start router for an outgoing (to engine), not utility, channel
target | The target to call |
params | Call parameters |
const String& transferId | ( | ) | const [inline] |
Get the transferred peer's id
void update | ( | int | notif, |
bool | chan = true , |
||
bool | updatePeer = true , |
||
const char * | engineMsg = 0 , |
||
bool | minimal = false , |
||
bool | data = false |
||
) |
Update channel. Enqueue a clientchan.update message with the given operation. Enqueue other channel status messages if required
notif | The value of the notify parameter |
chan | Set the channel as message's user data |
updatePeer | True to update peer's data formats |
engineMsg | Optional message to enqueue in the engine |
minimal | Set to true to fill in only a minimum of engine message's parameters |
data | Set the channel as engine message's user data |
const TokenDict s_notification[] [static] |
Channel notifications dictionary
const TokenDict s_slaveTypes[] [static] |
Channel notifications dictionary