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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
<HTML>
<HEAD>
<TITLE>class ClientChannel</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 ClientChannel</h1>
</TD>
<TD valign="top" align="right" colspan="1">Channel used by client programs. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::ClientChannel</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><A HREF="TelEngine__Channel.html">TelEngine::Channel</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__ClientChannel.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 Types</h4><ul><LI>enum <A HREF="#ref2">Notification</A> { Startup,
Destroyed,
Active,
OnHold,
Mute,
Noticed,
AddrChanged,
Routed,
Accepted,
Rejected,
Progressing,
Ringing,
Answered,
Transfer,
Conference,
Unknown
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref3">ClientChannel</A></b> (const Message& msg, const String& peerid)
</LI>
<LI> <b><A HREF="#ref4">ClientChannel</A></b> (const String& target, const NamedList& params)
</LI>
<LI> <b><A HREF="#ref5">ClientChannel</A></b> (const String& soundId)
</LI>
<LI>virtual <b><A HREF="#ref6">~ClientChannel</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref7">start</A></b> (const String& target, const NamedList& params)
</LI>
<LI>virtual bool <b><A HREF="#ref8">msgProgress</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref9">msgRinging</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref10">msgAnswered</A></b> (Message& msg)
</LI>
<LI>virtual bool <b><A HREF="#ref11">msgDrop</A></b> (Message& msg, const char* reason)
</LI>
<LI>virtual bool <b><A HREF="#ref12">callRouted</A></b> (Message& msg)
</LI>
<LI>virtual void <b><A HREF="#ref13">callAccept</A></b> (Message& msg)
</LI>
<LI>virtual void <b><A HREF="#ref14">callRejected</A></b> (const char* error, const char* reason, const Message* msg)
</LI>
<LI>void <b><A HREF="#ref15">callAnswer</A></b> (bool setActive = true)
</LI>
<LI>inline const String& <b><A HREF="#ref16">party</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref17">conference</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref18">transferId</A></b> () const
</LI>
<LI>inline RefObject* <b><A HREF="#ref19">clientData</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref20">setClientData</A></b> (RefObject* obj = 0)
</LI>
<LI>bool <b><A HREF="#ref21">setMedia</A></b> (bool open = false, bool replace = false)
</LI>
<LI>bool <b><A HREF="#ref22">setActive</A></b> (bool active, bool update = true)
</LI>
<LI>bool <b><A HREF="#ref23">setMuted</A></b> (bool on, bool update = true)
</LI>
<LI>void <b><A HREF="#ref24">setTransfer</A></b> (const String& target = String::empty())
</LI>
<LI>void <b><A HREF="#ref25">setConference</A></b> (const String& target = String::empty())
</LI>
<LI>inline const String& <b><A HREF="#ref26">peerOutFormat</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref27">peerInFormat</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref28">active</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref29">muted</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref30">isNoticed</A></b> () const
</LI>
<LI>void <b><A HREF="#ref31">noticed</A></b> ()
</LI>
<LI>inline int <b><A HREF="#ref32">line</A></b> () const
</LI>
<LI>void <b><A HREF="#ref33">line</A></b> (int newLine)
</LI>
<LI>void <b><A HREF="#ref34">update</A></b> (int notif, bool chan = true,
bool updatePeer = true, const char* engineMsg = 0,
bool minimal = false, bool data = false)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static int <b><A HREF="#ref35">lookup</A></b> (const char* notif, int def = Unknown)
</LI>
<LI>static const char* <b><A HREF="#ref36">lookup</A></b> (int notif, const char* def = 0)
</LI>
</ul><h4>Public Members</h4><ul><LI>static TokenDict <b><A HREF="#ref37">s_notification[]</A></b></LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref38">destroyed</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref39">connected</A></b> (const char* reason)
</LI>
<LI>virtual void <b><A HREF="#ref40">disconnected</A></b> (bool final, const char* reason)
</LI>
<LI>inline bool <b><A HREF="#ref41">peerHasSource</A></b> (Message& msg)
</LI>
<LI>void <b><A HREF="#ref42">checkSilence</A></b> ()
</LI>
</ul><h4>Protected Members</h4><ul><LI>String <b><A HREF="#ref43">m_party</A></b></LI>
<LI>String <b><A HREF="#ref44">m_peerOutFormat</A></b></LI>
<LI>String <b><A HREF="#ref45">m_peerInFormat</A></b></LI>
<LI>String <b><A HREF="#ref46">m_reason</A></b></LI>
<LI>String <b><A HREF="#ref47">m_peerId</A></b></LI>
<LI>bool <b><A HREF="#ref48">m_noticed</A></b></LI>
<LI>int <b><A HREF="#ref49">m_line</A></b></LI>
<LI>bool <b><A HREF="#ref50">m_active</A></b></LI>
<LI>bool <b><A HREF="#ref51">m_silence</A></b></LI>
<LI>bool <b><A HREF="#ref52">m_conference</A></b></LI>
<LI>bool <b><A HREF="#ref53">m_muted</A></b></LI>
<LI>String <b><A HREF="#ref54">m_transferId</A></b></LI>
<LI>RefObject* <b><A HREF="#ref55">m_clientData</A></b></LI>
<LI>bool <b><A HREF="#ref56">m_utility</A></b></LI>
<LI>String <b><A HREF="#ref57">m_soundId</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class implements a Channel used by client programs
</p>
<A NAME="Notification"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Notification</strong> { Startup,
Destroyed,
Active,
OnHold,
Mute,
Noticed,
AddrChanged,
Routed,
Accepted,
Rejected,
Progressing,
Ringing,
Answered,
Transfer,
Conference,
Unknown
}
</td><td align="right"><h3><strong>Notification</strong></h3></td></tr></table><p></p><p>
Channel notifications
</p>
<A NAME="ClientChannel"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ClientChannel</strong> (const Message& msg, const String& peerid)
<br></td><td align="right"><h3><strong>ClientChannel</strong></h3></td></tr></table><p></p><p>
Incoming (from engine) constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msg</i></TD><TD align="left" valign="top">The call.execute message
</TD></TR>
<TR><TD align="left" valign="top"><i>peerid</i></TD><TD align="left" valign="top">The peer's id
</TD></TR>
</TABLE></P>
<A NAME="ClientChannel"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ClientChannel</strong> (const String& target, const NamedList& params)
<br></td><td align="right"><h3><strong>ClientChannel</strong></h3></td></tr></table><p></p><p>
Outgoing (to engine) constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The target to call
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Call parameters
</TD></TR>
</TABLE></P>
<A NAME="ClientChannel"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ClientChannel</strong> (const String& soundId)
<br></td><td align="right"><h3><strong>ClientChannel</strong></h3></td></tr></table><p></p><p>
Constructor for utility channels used to play notifications
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>soundId</i></TD><TD align="left" valign="top">The id of the sound to play
</TD></TR>
</TABLE></P>
<A NAME="~ClientChannel"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~ClientChannel</strong> ()
<br></td><td align="right"><h3><strong>~ClientChannel</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="start"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>start</strong> (const String& target, const NamedList& params)
<br></td><td align="right"><h3><strong>start</strong></h3></td></tr></table><p></p><p>
Init and start router for an outgoing (to engine), not utility, channel
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The target to call
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Call parameters
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="msgProgress"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgProgress</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgProgress</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#msgProgress">Channel</A>.</p>
<A NAME="msgRinging"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgRinging</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgRinging</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#msgRinging">Channel</A>.</p>
<A NAME="msgAnswered"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgAnswered</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgAnswered</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#msgAnswered">Channel</A>.</p>
<A NAME="msgDrop"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>msgDrop</strong> (Message& msg, const char* reason)
<br></td><td align="right"><h3><strong>msgDrop</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#msgDrop">Channel</A>.</p>
<A NAME="callRouted"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>callRouted</strong> (Message& msg)
<br></td><td align="right"><h3><strong>callRouted</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#callRouted">Channel</A>.</p>
<A NAME="callAccept"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>callAccept</strong> (Message& msg)
<br></td><td align="right"><h3><strong>callAccept</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#callAccept">Channel</A>.</p>
<A NAME="callRejected"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>callRejected</strong> (const char* error, const char* reason, const Message* msg)
<br></td><td align="right"><h3><strong>callRejected</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#callRejected">Channel</A>.</p>
<A NAME="callAnswer"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>callAnswer</strong> (bool setActive = true)
<br></td><td align="right"><h3><strong>callAnswer</strong></h3></td></tr></table><p></p><p>
Answer an incoming call. Set media channels. Enqueue a clientchan.update message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>setActive</i></TD><TD align="left" valign="top">True to activate the channel
</TD></TR>
</TABLE></P>
<A NAME="party"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>party</strong> ()
<br></td><td align="right"><h3><strong>party</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the remote party of this channel
</p>
<p><b>Returns</b>: The remote party of this channel
</p>
<A NAME="conference"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>conference</strong> ()
<br></td><td align="right"><h3><strong>conference</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this channel is in conference
</p>
<p><b>Returns</b>: True if this channel is in conference
</p>
<A NAME="transferId"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>transferId</strong> ()
<br></td><td align="right"><h3><strong>transferId</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the transferred peer's id
</p>
<p><b>Returns</b>: The transferred peer's id
</p>
<A NAME="clientData"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline RefObject* <strong>clientData</strong> ()
<br></td><td align="right"><h3><strong>clientData</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the client data
</p>
<p><b>Returns</b>: RefObject pointer or 0
</p>
<A NAME="setClientData"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setClientData</strong> (RefObject* obj = 0)
<br></td><td align="right"><h3><strong>setClientData</strong></h3></td></tr></table><p></p><p>
Set/reset the client data.
If a new client data is set its reference counter is increased
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>obj</i></TD><TD align="left" valign="top">The new client data
</TD></TR>
</TABLE></P>
<A NAME="setMedia"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setMedia</strong> (bool open = false, bool replace = false)
<br></td><td align="right"><h3><strong>setMedia</strong></h3></td></tr></table><p></p><p>
Attach/detach media channels
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>open</i></TD><TD align="left" valign="top">True to open, false to close
</TD></TR>
<TR><TD align="left" valign="top"><i>replace</i></TD><TD align="left" valign="top">True to replace media if already open. Ignored if open is false
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="setActive"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setActive</strong> (bool active, bool update = true)
<br></td><td align="right"><h3><strong>setActive</strong></h3></td></tr></table><p></p><p>
Set/reset this channel's data source/consumer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>active</i></TD><TD align="left" valign="top">True to set active, false to set inactive (mute)
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to enqueue an update message
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="setMuted"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>setMuted</strong> (bool on, bool update = true)
<br></td><td align="right"><h3><strong>setMuted</strong></h3></td></tr></table><p></p><p>
Set/reset this channel's muted flag. Set media if 'on' is false and the channel is active
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>on</i></TD><TD align="left" valign="top">True to reset outgoing media, false to set outgoing media
</TD></TR>
<TR><TD align="left" valign="top"><i>update</i></TD><TD align="left" valign="top">True to enqueue an update message
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="setTransfer"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setTransfer</strong> (const String& target = String::empty())
<br></td><td align="right"><h3><strong>setTransfer</strong></h3></td></tr></table><p></p><p>
Set/reset the transferred peer's id. Enqueue clientchan.update if changed.
Open media when reset if the channel is active and answered
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The transferred peer's id. Leave it blank to reset
</TD></TR>
</TABLE></P>
<A NAME="setConference"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setConference</strong> (const String& target = String::empty())
<br></td><td align="right"><h3><strong>setConference</strong></h3></td></tr></table><p></p><p>
Set/reset the conference data. Enqueue clientchan.update if changed.
Open media when reset if the channel is active and answered
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">The confeernce room's name. Leave it blank to reset
</TD></TR>
</TABLE></P>
<A NAME="peerOutFormat"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>peerOutFormat</strong> ()
<br></td><td align="right"><h3><strong>peerOutFormat</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the peer consumer's data format
</p>
<p><b>Returns</b>: The peer consumer's data format
</p>
<A NAME="peerInFormat"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>peerInFormat</strong> ()
<br></td><td align="right"><h3><strong>peerInFormat</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the peer source's data format
</p>
<p><b>Returns</b>: The peer source's data format
</p>
<A NAME="active"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>active</strong> ()
<br></td><td align="right"><h3><strong>active</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this channel is the active one
</p>
<p><b>Returns</b>: True if this channel is the active one
</p>
<A NAME="muted"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>muted</strong> ()
<br></td><td align="right"><h3><strong>muted</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this channel is muted
</p>
<p><b>Returns</b>: True if this channel is muted
</p>
<A NAME="isNoticed"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>isNoticed</strong> ()
<br></td><td align="right"><h3><strong>isNoticed</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this channel was noticed
</p>
<p><b>Returns</b>: True if this channel was noticed
</p>
<A NAME="noticed"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>noticed</strong> ()
<br></td><td align="right"><h3><strong>noticed</strong></h3></td></tr></table><p></p><p>
Notice this channel. Enqueue a clientchan.update message
</p>
<A NAME="line"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>line</strong> ()
<br></td><td align="right"><h3><strong>line</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get this channel's line
</p>
<p><b>Returns</b>: This channel's line
</p>
<A NAME="line"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>line</strong> (int newLine)
<br></td><td align="right"><h3><strong>line</strong></h3></td></tr></table><p></p><p>
Set this channel's line
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>newLine</i></TD><TD align="left" valign="top">This channel's line
</TD></TR>
</TABLE></P>
<A NAME="update"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>update</strong> (int notif, bool chan = true,
bool updatePeer = true, const char* engineMsg = 0,
bool minimal = false, bool data = false)
<br></td><td align="right"><h3><strong>update</strong></h3></td></tr></table><p></p><p>
Update channel. Enqueue a clientchan.update message with the given operation.
Enqueue other channel status messages if required
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>notif</i></TD><TD align="left" valign="top">The value of the notify parameter
</TD></TR>
<TR><TD align="left" valign="top"><i>chan</i></TD><TD align="left" valign="top">Set the channel as message's user data
</TD></TR>
<TR><TD align="left" valign="top"><i>updatePeer</i></TD><TD align="left" valign="top">True to update peer's data formats
</TD></TR>
<TR><TD align="left" valign="top"><i>engineMsg</i></TD><TD align="left" valign="top">Optional message to enqueue in the engine
</TD></TR>
<TR><TD align="left" valign="top"><i>minimal</i></TD><TD align="left" valign="top">Set to true to fill in only a minimum of engine message's parameters
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Set the channel as engine message's user data
</TD></TR>
</TABLE></P>
<A NAME="lookup"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>lookup</strong> (const char* notif, int def = Unknown)
<br></td><td align="right"><h3><strong>lookup</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Lookup for a notification id
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>notif</i></TD><TD align="left" valign="top">The notification's name
</TD></TR>
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Default value to return if not found
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The result
</p>
<A NAME="lookup"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const char* <strong>lookup</strong> (int notif, const char* def = 0)
<br></td><td align="right"><h3><strong>lookup</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Lookup for a notification name
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>notif</i></TD><TD align="left" valign="top">The notification's id
</TD></TR>
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Default value to return if not found
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The result
</p>
<A NAME="s_notification[]"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static TokenDict <strong>s_notification[]</strong>
</td><td align="right"><h3><strong>s_notification[]</strong></h3></td></tr></table><p></p><A NAME="destroyed"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>destroyed</strong> ()
<br></td><td align="right"><h3><strong>destroyed</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Channel notifications dictionary
</p>
<p>Reimplemented from <A HREF="TelEngine__CallEndpoint.html#destroyed">CallEndpoint</A>.</p>
<A NAME="connected"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>connected</strong> (const char* reason)
<br></td><td align="right"><h3><strong>connected</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#connected">Channel</A>.</p>
<A NAME="disconnected"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>disconnected</strong> (bool final, const char* reason)
<br></td><td align="right"><h3><strong>disconnected</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>Reimplemented from <A HREF="TelEngine__Channel.html#disconnected">Channel</A>.</p>
<A NAME="peerHasSource"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>peerHasSource</strong> (Message& msg)
<br></td><td align="right"><h3><strong>peerHasSource</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="checkSilence"></A><A NAME="ref42"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>checkSilence</strong> ()
<br></td><td align="right"><h3><strong>checkSilence</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_party"></A><A NAME="ref43"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_party</strong>
</td><td align="right"><h3><strong>m_party</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_peerOutFormat"></A><A NAME="ref44"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_peerOutFormat</strong>
</td><td align="right"><h3><strong>m_peerOutFormat</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_peerInFormat"></A><A NAME="ref45"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_peerInFormat</strong>
</td><td align="right"><h3><strong>m_peerInFormat</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_reason"></A><A NAME="ref46"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_reason</strong>
</td><td align="right"><h3><strong>m_reason</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_peerId"></A><A NAME="ref47"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_peerId</strong>
</td><td align="right"><h3><strong>m_peerId</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_noticed"></A><A NAME="ref48"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_noticed</strong>
</td><td align="right"><h3><strong>m_noticed</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_line"></A><A NAME="ref49"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_line</strong>
</td><td align="right"><h3><strong>m_line</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_active"></A><A NAME="ref50"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_active</strong>
</td><td align="right"><h3><strong>m_active</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_silence"></A><A NAME="ref51"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_silence</strong>
</td><td align="right"><h3><strong>m_silence</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_conference"></A><A NAME="ref52"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_conference</strong>
</td><td align="right"><h3><strong>m_conference</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_muted"></A><A NAME="ref53"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_muted</strong>
</td><td align="right"><h3><strong>m_muted</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_transferId"></A><A NAME="ref54"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_transferId</strong>
</td><td align="right"><h3><strong>m_transferId</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_clientData"></A><A NAME="ref55"></A><table width="100%"><tr bgcolor="#eeeeee"><td>RefObject* <strong>m_clientData</strong>
</td><td align="right"><h3><strong>m_clientData</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_utility"></A><A NAME="ref56"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_utility</strong>
</td><td align="right"><h3><strong>m_utility</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_soundId"></A><A NAME="ref57"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_soundId</strong>
</td><td align="right"><h3><strong>m_soundId</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>
|
