File: TelEngine__Driver.html

package info (click to toggle)
yate 2.2.0-1~dfsg-1.1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 17,496 kB
  • ctags: 21,687
  • sloc: cpp: 126,248; ansic: 11,462; sh: 3,573; php: 3,229; python: 2,014; makefile: 1,504; perl: 465; awk: 8
file content (394 lines) | stat: -rw-r--r-- 23,065 bytes parent folder | download
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
<HTML>
<HEAD>
<TITLE>class Driver</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 Driver</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">A Channel driver module. <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>::Driver</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="yatephone_h.html">yatephone.h</A>&gt;</code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__Module.html">TelEngine::Module</A> <small>[public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><i><A HREF="TelEngine__ClientDriver.html">ClientDriver</A></i></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__Driver.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>virtual  void* &nbsp;<b><A HREF="#ref15">getObject</A></b> (const String& name)  const
</LI>
<LI>inline const String& &nbsp;<b><A HREF="#ref16">prefix</A></b> ()  const
</LI>
<LI>inline bool &nbsp;<b><A HREF="#ref17">varchan</A></b> ()  const
</LI>
<LI>inline ObjList& &nbsp;<b><A HREF="#ref18">channels</A></b> () 
</LI>
<LI>virtual  Channel* &nbsp;<b><A HREF="#ref19">find</A></b> (const String& id)  const
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref20">isBusy</A></b> ()  const
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref21">dropAll</A></b> (Message &msg) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref22">canAccept</A></b> (bool routers = true) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref23">canRoute</A></b> () 
</LI>
<LI>unsigned int &nbsp;<b><A HREF="#ref24">nextid</A></b> () 
</LI>
<LI>inline unsigned int &nbsp;<b><A HREF="#ref25">lastid</A></b> ()  const
</LI>
<LI>inline int &nbsp;<b><A HREF="#ref26">timeout</A></b> ()  const
</LI>
<LI>inline int &nbsp;<b><A HREF="#ref27">routing</A></b> ()  const
</LI>
<LI>inline int &nbsp;<b><A HREF="#ref28">routed</A></b> ()  const
</LI>
<LI>inline int &nbsp;<b><A HREF="#ref29">total</A></b> ()  const
</LI>
</ul><h4>Protected Methods</h4><ul><LI>&nbsp;<b><A HREF="#ref30">Driver</A></b> (const char* name, const char* type = 0) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref31">initialize</A></b> () 
</LI>
<LI>void &nbsp;<b><A HREF="#ref32">setup</A></b> (const char* prefix = 0, bool minimal = false) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref33">received</A></b> (Message &msg, int id) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref34">genUpdate</A></b> (Message& msg) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref35">hasLine</A></b> (const String& line)  const
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref36">msgRoute</A></b> (Message& msg) 
</LI>
<LI>virtual  bool &nbsp;<b><i><A HREF="#ref37">msgExecute</A></i></b> (Message& msg, String& dest) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref38">commandComplete</A></b> (Message& msg, const String& partLine, const String& partWord) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref39">statusModule</A></b> (String& str) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref40">statusParams</A></b> (String& str) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref41">statusDetail</A></b> (String& str) 
</LI>
<LI>virtual  bool &nbsp;<b><A HREF="#ref42">setDebug</A></b> (Message& msg, const String& target) 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref43">loadLimits</A></b> () 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref44">varchan</A></b> (bool variable) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref45">timeout</A></b> (int tout) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref46">maxRoute</A></b> (int ncalls) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref47">maxChans</A></b> (int ncalls) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref48">dtmfDups</A></b> (bool duplicates) 
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
 Driver is a module specialized for implementing channel drivers
</p>
<A NAME="getObject"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void* &nbsp;<strong>getObject</strong> (const String& name)
<br></td><td align="right"><h3><strong>getObject</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
 Get a pointer to a derived class given that class name
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of the class we are asking for
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the requested class or NULL if this object doesn't implement it
     </p>
<p>Reimplemented from <A HREF="TelEngine__Module.html#getObject">Module</A>.</p>
<A NAME="prefix"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& &nbsp;<strong>prefix</strong> ()
<br></td><td align="right"><h3><strong>prefix</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Retrive the prefix that is used as base for all channels
</p>
<p><b>Returns</b>: The driver's prefix
     </p>
<A NAME="varchan"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool &nbsp;<strong>varchan</strong> ()
<br></td><td align="right"><h3><strong>varchan</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Check if this driver is for dynamic (variable number) channels
</p>
<p><b>Returns</b>: True if the channels are dynamic, false for fixed
     </p>
<A NAME="channels"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline ObjList& &nbsp;<strong>channels</strong> ()
<br></td><td align="right"><h3><strong>channels</strong></h3></td></tr></table><p></p><p>
 Get the list of channels of this driver
</p>
<p><b>Returns</b>: A reference to the channel list
     </p>
<A NAME="find"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Channel* &nbsp;<strong>find</strong> (const String& id)
<br></td><td align="right"><h3><strong>find</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
 Find a channel by 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">Unique identifier of the channel to find
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the channel or NULL if not found
     </p>
<A NAME="isBusy"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>isBusy</strong> ()
<br></td><td align="right"><h3><strong>isBusy</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
 Check if the driver is actively used.
</p>
<p><b>Returns</b>: True if the driver is in use, false if should be ok to restart
     </p>
<p>Reimplemented from <A HREF="TelEngine__Plugin.html#isBusy">Plugin</A>.</p>
<A NAME="dropAll"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>dropAll</strong> (Message &msg)
<br></td><td align="right"><h3><strong>dropAll</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Drop all current channels
</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">Notification message
     </TD></TR>
</TABLE></P>
<A NAME="canAccept"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>canAccept</strong> (bool routers = true)
<br></td><td align="right"><h3><strong>canAccept</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Check if new connections can be accepted
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>routers</i></TD><TD align="left" valign="top">Set to true to check routing threads for incoming connections
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if at least one new connection can be accepted, false if not
     </p>
<A NAME="canRoute"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>canRoute</strong> ()
<br></td><td align="right"><h3><strong>canRoute</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Check if new incoming connections can be routed
</p>
<p><b>Returns</b>: True if at least one new connection can be routed, false if not
     </p>
<A NAME="nextid"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int &nbsp;<strong>nextid</strong> ()
<br></td><td align="right"><h3><strong>nextid</strong></h3></td></tr></table><p></p><p>
 Get the next unique numeric id from a sequence
</p>
<p><b>Returns</b>: A driver unique number that increments by 1 at each call
     </p>
<A NAME="lastid"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int &nbsp;<strong>lastid</strong> ()
<br></td><td align="right"><h3><strong>lastid</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the current (last used) unique numeric id from a sequence
</p>
<p><b>Returns</b>: The driver unique number
     </p>
<A NAME="timeout"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int &nbsp;<strong>timeout</strong> ()
<br></td><td align="right"><h3><strong>timeout</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the default driver timeout
</p>
<p><b>Returns</b>: Timeout value in milliseconds
     </p>
<A NAME="routing"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int &nbsp;<strong>routing</strong> ()
<br></td><td align="right"><h3><strong>routing</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the number of calls currently in the routing stage
</p>
<p><b>Returns</b>: Number of router threads currently running
     </p>
<A NAME="routed"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int &nbsp;<strong>routed</strong> ()
<br></td><td align="right"><h3><strong>routed</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the number of calls successfully routed
</p>
<p><b>Returns</b>: Number of calls that have gone past the routing stage
     </p>
<A NAME="total"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int &nbsp;<strong>total</strong> ()
<br></td><td align="right"><h3><strong>total</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
 Get the total number of calls ever created
</p>
<p><b>Returns</b>: Number of channels ever created for this driver
     </p>
<A NAME="Driver"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>Driver</strong> (const char* name, const char* type = 0)
<br></td><td align="right"><h3><strong>Driver</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Plugin name of this driver
</TD></TR>
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the driver: "fixchans", "varchans", etc.
     </TD></TR>
</TABLE></P>
<A NAME="initialize"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>initialize</strong> ()
<br></td><td align="right"><h3><strong>initialize</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 This method is called to initialize the loaded module
     </p>
<p>Reimplemented from <A HREF="TelEngine__Module.html#initialize">Module</A>.</p>
<A NAME="setup"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>setup</strong> (const char* prefix = 0, bool minimal = false)
<br></td><td align="right"><h3><strong>setup</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Install standard message relays and set up the prefix
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>prefix</i></TD><TD align="left" valign="top">Prefix to use with channels of this driver
</TD></TR>
<TR><TD align="left" valign="top"><i>minimal</i></TD><TD align="left" valign="top">Install just a minimal set of message relays
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#setup">Module</A>.</p>
<A NAME="received"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>received</strong> (Message &msg, int id)
<br></td><td align="right"><h3><strong>received</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Message receiver handler
</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 received message
</TD></TR>
<TR><TD align="left" valign="top"><i>id</i></TD><TD align="left" valign="top">The identifier with which the relay was created
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop processing, false to try other handlers
     </p>
<p>Reimplemented from <A HREF="TelEngine__Module.html#received">Module</A>.</p>
<A NAME="genUpdate"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>genUpdate</strong> (Message& msg)
<br></td><td align="right"><h3><strong>genUpdate</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Opportunity to modify the update message
</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">Status update message
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#genUpdate">Module</A>.</p>
<A NAME="hasLine"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>hasLine</strong> (const String& line)
<br></td><td align="right"><h3><strong>hasLine</strong></h3></td></tr></table><p> <small>[protected const virtual]</small></p><p>
 Check if driver owns a client line (registered to an external server)
</p>
<p>     </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">Name of the line to check
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if this driver owns  line with the specified name
</p>
<A NAME="msgRoute"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>msgRoute</strong> (Message& msg)
<br></td><td align="right"><h3><strong>msgRoute</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Routing message handler. The default implementation routes to this
  driver if it owns a line named in the "account" or "line" parameter.
</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">Call routing message
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop processing the message, false to try other handlers
     </p>
<p>Reimplemented from <A HREF="TelEngine__Module.html#msgRoute">Module</A>.</p>
<A NAME="msgExecute"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<i><strong>msgExecute</strong></i> (Message& msg, String& dest)
<br></td><td align="right"><h3><i><strong>msgExecute</strong></i></h3></td></tr></table><p> <small>[protected pure virtual]</small></p><p>
 Create an outgoing calling channel
</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">Call execute message
</TD></TR>
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">Destination of the new call
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if outgoing call was created
     </p>
<A NAME="commandComplete"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>commandComplete</strong> (Message& msg, const String& partLine, const String& partWord)
<br></td><td align="right"><h3><strong>commandComplete</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Complete a command line
</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">Message to return completion into
</TD></TR>
<TR><TD align="left" valign="top"><i>partLine</i></TD><TD align="left" valign="top">Partial line to complete, excluding the last word
</TD></TR>
<TR><TD align="left" valign="top"><i>partWord</i></TD><TD align="left" valign="top">Partial word to complete
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True to stop processing the message, false to try other handlers
     </p>
<p>Reimplemented from <A HREF="TelEngine__Module.html#commandComplete">Module</A>.</p>
<A NAME="statusModule"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>statusModule</strong> (String& str)
<br></td><td align="right"><h3><strong>statusModule</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Build the module identification part of the status answer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String variable to fill up
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#statusModule">Module</A>.</p>
<A NAME="statusParams"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>statusParams</strong> (String& str)
<br></td><td align="right"><h3><strong>statusParams</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Build the parameter reporting part of the status answer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String variable to fill up
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#statusParams">Module</A>.</p>
<A NAME="statusDetail"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>statusDetail</strong> (String& str)
<br></td><td align="right"><h3><strong>statusDetail</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Build the channel list part of the status answer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>str</i></TD><TD align="left" valign="top">String variable to fill up
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#statusDetail">Module</A>.</p>
<A NAME="setDebug"></A><A NAME="ref42"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool &nbsp;<strong>setDebug</strong> (Message& msg, const String& target)
<br></td><td align="right"><h3><strong>setDebug</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Set the local debugging level
</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">Debug setting message
</TD></TR>
<TR><TD align="left" valign="top"><i>target</i></TD><TD align="left" valign="top">String to match for local settings
     </TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__Module.html#setDebug">Module</A>.</p>
<A NAME="loadLimits"></A><A NAME="ref43"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>loadLimits</strong> ()
<br></td><td align="right"><h3><strong>loadLimits</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
 Load the global limits from the main config file
     </p>
<A NAME="varchan"></A><A NAME="ref44"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>varchan</strong> (bool variable)
<br></td><td align="right"><h3><strong>varchan</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Set if this driver is for dynamic (variable number) channels
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>variable</i></TD><TD align="left" valign="top">True if the channels are dynamic, false for fixed
     </TD></TR>
</TABLE></P>
<A NAME="timeout"></A><A NAME="ref45"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>timeout</strong> (int tout)
<br></td><td align="right"><h3><strong>timeout</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Set the default driver timeout
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tout</i></TD><TD align="left" valign="top">New timeout in milliseconds or zero to disable
     </TD></TR>
</TABLE></P>
<A NAME="maxRoute"></A><A NAME="ref46"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>maxRoute</strong> (int ncalls)
<br></td><td align="right"><h3><strong>maxRoute</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Set the maximum number of routing messages for this driver
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ncalls</i></TD><TD align="left" valign="top">Number of calls to route simultaneously, zero to accept all
     </TD></TR>
</TABLE></P>
<A NAME="maxChans"></A><A NAME="ref47"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>maxChans</strong> (int ncalls)
<br></td><td align="right"><h3><strong>maxChans</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Set the maximum number of running channels for this driver
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ncalls</i></TD><TD align="left" valign="top">Number of calls to run simultaneously, zero to accept all
     </TD></TR>
</TABLE></P>
<A NAME="dtmfDups"></A><A NAME="ref48"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>dtmfDups</strong> (bool duplicates)
<br></td><td align="right"><h3><strong>dtmfDups</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Set the DTMF duplicates allowed flag
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>duplicates</i></TD><TD align="left" valign="top">True to allow DTMF duplicate messages
     </TD></TR>
</TABLE></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>