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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
<HTML>
<HEAD>
<TITLE>class ISDNFrame</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 ISDNFrame</h1>
</TD>
<TD valign="top" align="right" colspan="1">An ISDN frame. <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>::ISDNFrame</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ysig___yatesig_h.html">libs/ysig/yatesig.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__RefObject.html">TelEngine::RefObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__ISDNFrame.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="#ref3">Type</A> { DISC = 1,
DM = 2,
FRMR = 3,
I = 4,
REJ = 5,
RNR = 6,
RR = 7,
SABME = 8,
UA = 9,
UI = 10,
XID = 11,
Invalid = 100,
ErrUnknownCR = 101,
ErrHdrLength = 102,
ErrDataLength = 103,
ErrRxSeqNo = 104,
ErrTxSeqNo = 105,
ErrInvalidEA = 106,
ErrInvalidAddress = 107,
ErrUnsupported = 108,
ErrInvalidCR = 109,
}
</LI>
<LI>enum <A HREF="#ref4">TeiManagement</A> { TeiReq = 1,
TeiAssigned = 2,
TeiDenied = 3,
TeiCheckReq = 4,
TeiCheckRsp = 5,
TeiRemove = 6,
TeiVerify = 7
}
</LI>
<LI>enum <A HREF="#ref5">Category</A> { Data,
Supervisory,
Unnumbered,
Error
}
</LI>
</ul><h4>Public Methods</h4><ul><LI>virtual <b><A HREF="#ref6">~ISDNFrame</A></b> ()
</LI>
<LI>inline Type <b><A HREF="#ref7">type</A></b> () const
</LI>
<LI>inline Type <b><A HREF="#ref8">error</A></b> () const
</LI>
<LI>inline Category <b><A HREF="#ref9">category</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref10">command</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref11">sapi</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref12">tei</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref13">poll</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref14">ns</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref15">nr</A></b> () const
</LI>
<LI>inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref16">headerLength</A></b> () const
</LI>
<LI>inline <A HREF="#u_int32_t">u_int32_t</A> <b><A HREF="#ref17">dataLength</A></b> () const
</LI>
<LI>inline const DataBlock& <b><A HREF="#ref18">buffer</A></b> () const
</LI>
<LI>inline bool <b><A HREF="#ref19">sent</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref20">sent</A></b> (bool value)
</LI>
<LI>inline const char* <b><A HREF="#ref21">name</A></b> () const
</LI>
<LI>void <b><A HREF="#ref22">update</A></b> (<A HREF="#u_int8_t">u_int8_t</A>* ns = 0, <A HREF="#u_int8_t">u_int8_t</A>* nr = 0)
</LI>
<LI>inline void <b><A HREF="#ref23">getData</A></b> (DataBlock& dest) const
</LI>
<LI>void <b><A HREF="#ref24">toString</A></b> (String& dest, bool extendedDebug) const
</LI>
<LI>bool <b><A HREF="#ref25">checkTeiManagement</A></b> () const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static <A HREF="#u_int16_t">u_int16_t</A> <b><A HREF="#ref26">getRi</A></b> (const DataBlock& data)
</LI>
<LI>static inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref27">getType</A></b> (const DataBlock& data)
</LI>
<LI>static inline <A HREF="#u_int8_t">u_int8_t</A> <b><A HREF="#ref28">getAi</A></b> (const DataBlock& data)
</LI>
<LI>static ISDNFrame* <b><A HREF="#ref29">parse</A></b> (const DataBlock& data, ISDNLayer2* receiver)
</LI>
<LI>static bool <b><A HREF="#ref30">buildTeiManagement</A></b> (DataBlock& data, <A HREF="#u_int8_t">u_int8_t</A> type, <A HREF="#u_int16_t">u_int16_t</A> ri,
<A HREF="#u_int8_t">u_int8_t</A> ai)
</LI>
<LI>static inline bool <b><A HREF="#ref31">commandBit</A></b> (bool network)
</LI>
<LI>static inline bool <b><A HREF="#ref32">responseBit</A></b> (bool network)
</LI>
<LI>static inline bool <b><A HREF="#ref33">isCommand</A></b> (<A HREF="#u_int8_t">u_int8_t</A> cr, bool sentByNetwork)
</LI>
<LI>static inline const char* <b><A HREF="#ref34">typeName</A></b> (Type type)
</LI>
</ul><h4>Public Members</h4><ul><LI>static TokenDict <b><A HREF="#ref35">s_types[]</A></b></LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref36">ISDNFrame</A></b> (Type type = Invalid)
</LI>
<LI> <b><A HREF="#ref37">ISDNFrame</A></b> (Type type, bool command, bool senderNetwork,
<A HREF="#u_int8_t">u_int8_t</A> sapi, <A HREF="#u_int8_t">u_int8_t</A> tei, bool pf, <A HREF="#u_int8_t">u_int8_t</A> nr = 0)
</LI>
<LI> <b><A HREF="#ref38">ISDNFrame</A></b> (bool ack, bool senderNetwork, <A HREF="#u_int8_t">u_int8_t</A> sapi, <A HREF="#u_int8_t">u_int8_t</A> tei,
bool pf, const DataBlock& data)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Encapsulates an ISDN (Q.921) frame exchanged over a hardware HDLC interface
</p>
<A NAME="Type"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Type</strong> { DISC = 1,
DM = 2,
FRMR = 3,
I = 4,
REJ = 5,
RNR = 6,
RR = 7,
SABME = 8,
UA = 9,
UI = 10,
XID = 11,
Invalid = 100,
ErrUnknownCR = 101,
ErrHdrLength = 102,
ErrDataLength = 103,
ErrRxSeqNo = 104,
ErrTxSeqNo = 105,
ErrInvalidEA = 106,
ErrInvalidAddress = 107,
ErrUnsupported = 108,
ErrInvalidCR = 109,
}
</td><td align="right"><h3><strong>Type</strong></h3></td></tr></table><p></p><p>
Frame type according to Q.921 3.6
</p>
<A NAME="TeiManagement"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>TeiManagement</strong> { TeiReq = 1,
TeiAssigned = 2,
TeiDenied = 3,
TeiCheckReq = 4,
TeiCheckRsp = 5,
TeiRemove = 6,
TeiVerify = 7
}
</td><td align="right"><h3><strong>TeiManagement</strong></h3></td></tr></table><p></p><p>
Codes used for TEI management procedures (Q.921 Table 8)
</p>
<A NAME="Category"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Category</strong> { Data,
Supervisory,
Unnumbered,
Error
}
</td><td align="right"><h3><strong>Category</strong></h3></td></tr></table><p></p><p>
Frame category
</p>
<A NAME="~ISDNFrame"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~ISDNFrame</strong> ()
<br></td><td align="right"><h3><strong>~ISDNFrame</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="type"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Type <strong>type</strong> ()
<br></td><td align="right"><h3><strong>type</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the type of this frame
</p>
<p><b>Returns</b>: The type of this frame as enumeration
</p>
<A NAME="error"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Type <strong>error</strong> ()
<br></td><td align="right"><h3><strong>error</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the error type
</p>
<p><b>Returns</b>: The error type of this frame as enumeration
</p>
<A NAME="category"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline Category <strong>category</strong> ()
<br></td><td align="right"><h3><strong>category</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the category of this frame
</p>
<p><b>Returns</b>: The category of this frame as enumeration
</p>
<A NAME="command"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>command</strong> ()
<br></td><td align="right"><h3><strong>command</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this frame is a command
</p>
<p><b>Returns</b>: True if this frame is a command. False if it is a response
</p>
<A NAME="sapi"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>sapi</strong> ()
<br></td><td align="right"><h3><strong>sapi</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the SAPI of this frame
</p>
<p><b>Returns</b>: The SAPI of this frame
</p>
<A NAME="tei"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>tei</strong> ()
<br></td><td align="right"><h3><strong>tei</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the TEI of this frame
</p>
<p><b>Returns</b>: The TEI of this frame
</p>
<A NAME="poll"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>poll</strong> ()
<br></td><td align="right"><h3><strong>poll</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this frame is a poll (expect response) or a final one
</p>
<p><b>Returns</b>: True if this a poll frame. False if it is a final one
</p>
<A NAME="ns"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>ns</strong> ()
<br></td><td align="right"><h3><strong>ns</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the transmitter send sequence number
</p>
<p><b>Returns</b>: The transmitter send sequence number
</p>
<A NAME="nr"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>nr</strong> ()
<br></td><td align="right"><h3><strong>nr</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the transmitter receive sequence number
</p>
<p><b>Returns</b>: The transmitter receive sequence number
</p>
<A NAME="headerLength"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>headerLength</strong> ()
<br></td><td align="right"><h3><strong>headerLength</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the length of the frame's header
</p>
<p><b>Returns</b>: The length of the frame's header
</p>
<A NAME="dataLength"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int32_t">u_int32_t</A> <strong>dataLength</strong> ()
<br></td><td align="right"><h3><strong>dataLength</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the length of the data carried by this frame
</p>
<p><b>Returns</b>: The length of the data carried by this frame
</p>
<A NAME="buffer"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const DataBlock& <strong>buffer</strong> ()
<br></td><td align="right"><h3><strong>buffer</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the frame's buffer
</p>
<p><b>Returns</b>: The frame's buffer
</p>
<A NAME="sent"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>sent</strong> ()
<br></td><td align="right"><h3><strong>sent</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the frame was sent
</p>
<p><b>Returns</b>: True if the frame was sent
</p>
<A NAME="sent"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>sent</strong> (bool value)
<br></td><td align="right"><h3><strong>sent</strong></h3></td></tr></table><p></p><p>
Set transmitted flag
</p>
<A NAME="name"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const char* <strong>name</strong> ()
<br></td><td align="right"><h3><strong>name</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the text associated with the frame's type
</p>
<p><b>Returns</b>: The text associated with the frame's type
</p>
<A NAME="update"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>update</strong> (<A HREF="#u_int8_t">u_int8_t</A>* ns = 0, <A HREF="#u_int8_t">u_int8_t</A>* nr = 0)
<br></td><td align="right"><h3><strong>update</strong></h3></td></tr></table><p></p><p>
Update sequence numbers for I frames
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ns</i></TD><TD align="left" valign="top">Optional update send sequence number
</TD></TR>
<TR><TD align="left" valign="top"><i>nr</i></TD><TD align="left" valign="top">Optional update receive sequence number
</TD></TR>
</TABLE></P>
<A NAME="getData"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>getData</strong> (DataBlock& dest)
<br></td><td align="right"><h3><strong>getData</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the data transferred with this frame
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">The destination buffer
</TD></TR>
</TABLE></P>
<A NAME="toString"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>toString</strong> (String& dest, bool extendedDebug)
<br></td><td align="right"><h3><strong>toString</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Write this frame to a string for debug purposes
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">The destination string
</TD></TR>
<TR><TD align="left" valign="top"><i>extendedDebug</i></TD><TD align="left" valign="top">True to dump message header and data
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#toString">GenObject</A>.</p>
<A NAME="checkTeiManagement"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>checkTeiManagement</strong> ()
<br></td><td align="right"><h3><strong>checkTeiManagement</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the received frame is a TEI management frame
</p>
<p><b>Returns</b>: True if the frame is a TEI management one, false if it's not
</p>
<A NAME="getRi"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="#u_int16_t">u_int16_t</A> <strong>getRi</strong> (const DataBlock& data)
<br></td><td align="right"><h3><strong>getRi</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get reference number from frame
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">The data block which contains it
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference number
</p>
<A NAME="getType"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>getType</strong> (const DataBlock& data)
<br></td><td align="right"><h3><strong>getType</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get frame message type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">The data block which contains it
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Message type
</p>
<A NAME="getAi"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <A HREF="#u_int8_t">u_int8_t</A> <strong>getAi</strong> (const DataBlock& data)
<br></td><td align="right"><h3><strong>getAi</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get action indicator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Data block which contains it
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Action indicator value
</p>
<A NAME="parse"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td> ISDNFrame* <strong>parse</strong> (const DataBlock& data, ISDNLayer2* receiver)
<br></td><td align="right"><h3><strong>parse</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Parse a received data block
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Data to parse
</TD></TR>
<TR><TD align="left" valign="top"><i>receiver</i></TD><TD align="left" valign="top">The receiver of the data
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: ISDNFrame pointer or 0 (no control field)
</p>
<A NAME="buildTeiManagement"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>buildTeiManagement</strong> (DataBlock& data, <A HREF="#u_int8_t">u_int8_t</A> type, <A HREF="#u_int16_t">u_int16_t</A> ri,
<A HREF="#u_int8_t">u_int8_t</A> ai)
<br></td><td align="right"><h3><strong>buildTeiManagement</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Build a TEI management message buffer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Destination buffer to fill
</TD></TR>
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">The message type
</TD></TR>
<TR><TD align="left" valign="top"><i>ri</i></TD><TD align="left" valign="top">The reference number
</TD></TR>
<TR><TD align="left" valign="top"><i>ai</i></TD><TD align="left" valign="top">The action indicator
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on succes
</p>
<A NAME="commandBit"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td> inline bool <strong>commandBit</strong> (bool network)
<br></td><td align="right"><h3><strong>commandBit</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the command bit value for a given side of a data link
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>network</i></TD><TD align="left" valign="top">True for the network side,
false for the user side of a data link
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The appropriate command bit value
</p>
<A NAME="responseBit"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td> inline bool <strong>responseBit</strong> (bool network)
<br></td><td align="right"><h3><strong>responseBit</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the response bit value for a given side of a data link
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>network</i></TD><TD align="left" valign="top">True for the network side,
false for the user side of a data link
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The appropriate response bit value
</p>
<A NAME="isCommand"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td> inline bool <strong>isCommand</strong> (<A HREF="#u_int8_t">u_int8_t</A> cr, bool sentByNetwork)
<br></td><td align="right"><h3><strong>isCommand</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the command/response type from C/R bit value and sender type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>cr</i></TD><TD align="left" valign="top">The value of the C/R bit
</TD></TR>
<TR><TD align="left" valign="top"><i>sentByNetwork</i></TD><TD align="left" valign="top">True if the sender is the network side of the data link
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if it is a command
</p>
<A NAME="typeName"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td> inline const char* <strong>typeName</strong> (Type type)
<br></td><td align="right"><h3><strong>typeName</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the text associated with the given frame type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Frame type to get the text for
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The text associated with the given frame type
</p>
<A NAME="s_types[]"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>static TokenDict <strong>s_types[]</strong>
</td><td align="right"><h3><strong>s_types[]</strong></h3></td></tr></table><p></p><A NAME="ISDNFrame"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ISDNFrame</strong> (Type type = Invalid)
<br></td><td align="right"><h3><strong>ISDNFrame</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor
Used by the parser
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Frame type
</TD></TR>
</TABLE></P>
<A NAME="ISDNFrame"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ISDNFrame</strong> (Type type, bool command, bool senderNetwork,
<A HREF="#u_int8_t">u_int8_t</A> sapi, <A HREF="#u_int8_t">u_int8_t</A> tei, bool pf, <A HREF="#u_int8_t">u_int8_t</A> nr = 0)
<br></td><td align="right"><h3><strong>ISDNFrame</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor
Create U/S frames: SABME/DM/DISC/UA/FRMR/XID/RR/RNR/REJ
Set data members. Encode frame in buffer according to Q.921
Used by ISDNLayer2 to create outgoing frames
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Frame type
</TD></TR>
<TR><TD align="left" valign="top"><i>command</i></TD><TD align="left" valign="top">Frame command/response's flag
</TD></TR>
<TR><TD align="left" valign="top"><i>senderNetwork</i></TD><TD align="left" valign="top">True if the sender is the network side of the data link
</TD></TR>
<TR><TD align="left" valign="top"><i>sapi</i></TD><TD align="left" valign="top">SAPI value
</TD></TR>
<TR><TD align="left" valign="top"><i>tei</i></TD><TD align="left" valign="top">TEI value
</TD></TR>
<TR><TD align="left" valign="top"><i>pf</i></TD><TD align="left" valign="top">Poll/final flag
</TD></TR>
<TR><TD align="left" valign="top"><i>nr</i></TD><TD align="left" valign="top">Optional transmitter receive sequence number
</TD></TR>
</TABLE></P>
<A NAME="ISDNFrame"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>ISDNFrame</strong> (bool ack, bool senderNetwork, <A HREF="#u_int8_t">u_int8_t</A> sapi, <A HREF="#u_int8_t">u_int8_t</A> tei,
bool pf, const DataBlock& data)
<br></td><td align="right"><h3><strong>ISDNFrame</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Constructor
Create I/UI frames
Set data members. Encode frame in buffer according to Q.921
Used by ISDNLayer2 to create outgoing frames
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ack</i></TD><TD align="left" valign="top">True to create an I frame. False to create an UI frame
</TD></TR>
<TR><TD align="left" valign="top"><i>senderNetwork</i></TD><TD align="left" valign="top">True if the sender is the network side of the data link
</TD></TR>
<TR><TD align="left" valign="top"><i>sapi</i></TD><TD align="left" valign="top">SAPI value
</TD></TR>
<TR><TD align="left" valign="top"><i>tei</i></TD><TD align="left" valign="top">TEI value
</TD></TR>
<TR><TD align="left" valign="top"><i>pf</i></TD><TD align="left" valign="top">Poll/final flag
</TD></TR>
<TR><TD align="left" valign="top"><i>data</i></TD><TD align="left" valign="top">Transmitted data
</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>
|
