1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<HTML>
<HEAD>
<TITLE>class ClientDriver</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class ClientDriver</h1>
</TD>
<TD valign="top" align="right" colspan="1">Base Driver with client specific functions. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::ClientDriver</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yatecbase_h.html">yatecbase.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><i><A HREF="TelEngine__Driver.html">TelEngine::Driver</A></i> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__ClientDriver.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref2">ClientDriver</A></b> ()
</LI>
<LI>virtual <b><A HREF="#ref3">~ClientDriver</A></b> ()
</LI>
<LI>virtual void <b><i><A HREF="#ref4">initialize</A></i></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref5">msgExecute</A></b> (Message& msg, String& dest)
</LI>
<LI>virtual void <b><A HREF="#ref6">msgTimer</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref7">msgRoute</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref8">received</A></b> (Message& msg, int id)
</LI>
<LI>inline const String& <b><A HREF="#ref9">activeId</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref10">setActive</A></b> (const String& id = String::empty())
</LI>
<LI>ClientChannel* <b><A HREF="#ref11">findLine</A></b> (int line)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static inline ClientDriver* <b><A HREF="#ref12">self</A></b> ()
</LI>
<LI>static inline const String& <b><A HREF="#ref13">device</A></b> ()
</LI>
<LI>static void <b><A HREF="#ref14">dropCalls</A></b> (const char* reason = 0)
</LI>
<LI>static bool <b><A HREF="#ref15">setAudioTransfer</A></b> (const String& id, const String& target = String::empty())
</LI>
<LI>static bool <b><A HREF="#ref16">setConference</A></b> (const String& id, bool in, const String* confName = 0)
</LI>
<LI>static ClientChannel* <b><A HREF="#ref17">findChan</A></b> (const String& id)
</LI>
<LI>static ClientChannel* <b><A HREF="#ref18">findChanByPeer</A></b> (const String& peer)
</LI>
<LI>static ClientChannel* <b><A HREF="#ref19">findActiveChan</A></b> ()
</LI>
</ul><h4>Public Members</h4><ul><LI>static String <b><A HREF="#ref20">s_confName</A></b></LI>
<LI>static bool <b><A HREF="#ref21">s_dropConfPeer</A></b></LI>
</ul><h4>Protected Methods</h4><ul><LI>void <b><A HREF="#ref22">setup</A></b> ()
</LI>
</ul><h4>Protected Members</h4><ul><LI>static ClientDriver* <b><A HREF="#ref23">s_driver</A></b></LI>
<LI>static String <b><A HREF="#ref24">s_device</A></b></LI>
<LI>String <b><A HREF="#ref25">m_activeId</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Abstract client Driver that implements some of the specific functionality
</p>
<A NAME="ClientDriver"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ClientDriver</strong> ()
<br></td><td align="right"><h3><strong>ClientDriver</strong></h3></td></tr></table><p></p><A NAME="~ClientDriver"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~ClientDriver</strong> ()
<br></td><td align="right"><h3><strong>~ClientDriver</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="initialize"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <i><strong>initialize</strong></i> ()
<br></td><td align="right"><h3><i><strong>initialize</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Driver.html#initialize">Driver</A>.</p>
<A NAME="msgExecute"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgExecute</strong> (Message& msg, String& dest)
<br></td><td align="right"><h3><strong>msgExecute</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Driver.html#msgExecute">Driver</A>.</p>
<A NAME="msgTimer"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>msgTimer</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgTimer</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Module.html#msgTimer">Module</A>.</p>
<A NAME="msgRoute"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgRoute</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgRoute</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Driver.html#msgRoute">Driver</A>.</p>
<A NAME="received"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>received</strong> (Message& msg, int id)
<br></td><td align="right"><h3><strong>received</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Driver.html#received">Driver</A>.</p>
<A NAME="activeId"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>activeId</strong> ()
<br></td><td align="right"><h3><strong>activeId</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the active channel's id
</p>
<p><b>Returns</b>: The active channel's id
</p>
<A NAME="setActive"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setActive</strong> (const String& id = String::empty())
<br></td><td align="right"><h3><strong>setActive</strong></h3></td></tr></table><p></p><p>
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
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">The new active channel's id. Set to empty if don't want
to set a new active channel
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="findLine"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ClientChannel* <strong>findLine</strong> (int line)
<br></td><td align="right"><h3><strong>findLine</strong></h3></td></tr></table><p></p><p>
Find a channel by its line
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>line</i></TD><TD align="left" valign="top">The line to find
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: ClientChannel pointer of 0
</p>
<A NAME="self"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline ClientDriver* <strong>self</strong> ()
<br></td><td align="right"><h3><strong>self</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the global client driver object's address
</p>
<p><b>Returns</b>: The global client driver object's address
</p>
<A NAME="device"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>device</strong> ()
<br></td><td align="right"><h3><strong>device</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the current audio device's name
</p>
<p><b>Returns</b>: The current audio device's name
</p>
<A NAME="dropCalls"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>dropCalls</strong> (const char* reason = 0)
<br></td><td align="right"><h3><strong>dropCalls</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Drop all calls belonging to the active driver
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>reason</i></TD><TD align="left" valign="top">Optional drop reason
</TD></TR>
</TABLE></P>
<A NAME="setAudioTransfer"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>setAudioTransfer</strong> (const String& id, const String& target = String::empty())
<br></td><td align="right"><h3><strong>setAudioTransfer</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Attach/detach client channels peers' source/consumer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">The id of the channel to tranfer
</TD></TR>
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The transfer target. Leave blank to reset the channel's transfer id
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="setConference"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>setConference</strong> (const String& id, bool in, const String* confName = 0)
<br></td><td align="right"><h3><strong>setConference</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Attach/detach a client channel to/from a conference room
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">The id of the channel to process
</TD></TR>
<TR><TD align="left" valign="top"><i>in</i></TD><TD align="left" valign="top">True to enter the conference room, false to exit from it
</TD></TR>
<TR><TD align="left" valign="top"><i>confName</i></TD><TD align="left" valign="top">Optional id of the conference. Set to 0 to use the default one
Ignored if 'in' is false
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="findChan"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> ClientChannel* <strong>findChan</strong> (const String& id)
<br></td><td align="right"><h3><strong>findChan</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get a referenced channel found by its id
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">The id of the channel to find
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Referenced ClientChannel pointer or 0
</p>
<A NAME="findChanByPeer"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> ClientChannel* <strong>findChanByPeer</strong> (const String& peer)
<br></td><td align="right"><h3><strong>findChanByPeer</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get a referenced channel whose stored peer is the given one
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>peer</i></TD><TD align="left" valign="top">Peer id to check
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Referenced ClientChannel pointer or 0
</p>
<A NAME="findActiveChan"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> ClientChannel* <strong>findActiveChan</strong> ()
<br></td><td align="right"><h3><strong>findActiveChan</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the active channel
</p>
<p><b>Returns</b>: Referenced ClientChannel pointer or 0
</p>
<A NAME="s_confName"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static String <strong>s_confName</strong>
</td><td align="right"><h3><strong>s_confName</strong></h3></td></tr></table><p></p><A NAME="s_dropConfPeer"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static bool <strong>s_dropConfPeer</strong>
</td><td align="right"><h3><strong>s_dropConfPeer</strong></h3></td></tr></table><p></p><A NAME="setup"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setup</strong> ()
<br></td><td align="right"><h3><strong>setup</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Indicates wether a channel should drop its former peer when
terminated while in conference
</p>
<p>Reimplemented from <A HREF="TelEngine__Driver.html#setup">Driver</A>.</p>
<A NAME="s_driver"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static ClientDriver* <strong>s_driver</strong>
</td><td align="right"><h3><strong>s_driver</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="s_device"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static String <strong>s_device</strong>
</td><td align="right"><h3><strong>s_device</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_activeId"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_activeId</strong>
</td><td align="right"><h3><strong>m_activeId</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
