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
|
<HTML>
<HEAD>
<TITLE>class SS7Label</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 SS7Label</h1>
</TD>
<TD valign="top" align="right" colspan="1">SS7 Routing Label. <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>::SS7Label</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><A HREF="full-list-TelEngine__SS7Label.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="#ref1">SS7Label</A></b> ()
</LI>
<LI> <b><A HREF="#ref2">SS7Label</A></b> (const SS7Label& original)
</LI>
<LI> <b><A HREF="#ref3">SS7Label</A></b> (const SS7Label& original, unsigned char sls, unsigned char spare = 0)
</LI>
<LI> <b><A HREF="#ref4">SS7Label</A></b> (SS7PointCode::Type type, const SS7PointCode& dpc,
const SS7PointCode& opc, unsigned char sls, unsigned char spare = 0)
</LI>
<LI> <b><A HREF="#ref5">SS7Label</A></b> (SS7PointCode::Type type, unsigned int dpc,
unsigned int opc, unsigned char sls, unsigned char spare = 0)
</LI>
<LI> <b><A HREF="#ref6">SS7Label</A></b> (SS7PointCode::Type type, const SS7MSU& msu)
</LI>
<LI>void <b><A HREF="#ref7">assign</A></b> (SS7PointCode::Type type, const SS7PointCode& dpc,
const SS7PointCode& opc, unsigned char sls, unsigned char spare = 0)
</LI>
<LI>void <b><A HREF="#ref8">assign</A></b> (SS7PointCode::Type type, unsigned int dpc,
unsigned int opc, unsigned char sls, unsigned char spare = 0)
</LI>
<LI>bool <b><A HREF="#ref9">assign</A></b> (SS7PointCode::Type type, const SS7MSU& msu)
</LI>
<LI>bool <b><A HREF="#ref10">assign</A></b> (SS7PointCode::Type type, const unsigned char* src, int len = -1)
</LI>
<LI>bool <b><A HREF="#ref11">store</A></b> (unsigned char* dest) const
</LI>
<LI>bool <b><A HREF="#ref12">compatible</A></b> (SS7PointCode::Type type) const
</LI>
<LI>inline SS7PointCode::Type <b><A HREF="#ref13">type</A></b> () const
</LI>
<LI>inline const SS7PointCode& <b><A HREF="#ref14">dpc</A></b> () const
</LI>
<LI>inline SS7PointCode& <b><A HREF="#ref15">dpc</A></b> ()
</LI>
<LI>inline const SS7PointCode& <b><A HREF="#ref16">opc</A></b> () const
</LI>
<LI>inline SS7PointCode& <b><A HREF="#ref17">opc</A></b> ()
</LI>
<LI>inline unsigned char <b><A HREF="#ref18">sls</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref19">setSls</A></b> (unsigned char sls)
</LI>
<LI>inline unsigned char <b><A HREF="#ref20">spare</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref21">setSpare</A></b> (unsigned char spare)
</LI>
<LI>inline unsigned int <b><A HREF="#ref22">length</A></b> () const
</LI>
<LI>inline unsigned char <b><A HREF="#ref24">size</A></b> () const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static unsigned int <b><A HREF="#ref23">length</A></b> (SS7PointCode::Type type)
</LI>
<LI>static unsigned char <b><A HREF="#ref25">size</A></b> (SS7PointCode::Type type)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A SS7 Layer 3 routing label, both ANSI and ITU capable
</p>
<A NAME="SS7Label"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> ()
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Constructor of an empty, invalid label
</p>
<A NAME="SS7Label"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> (const SS7Label& original)
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Copy constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Label to copy
</TD></TR>
</TABLE></P>
<A NAME="SS7Label"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> (const SS7Label& original, unsigned char sls, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Swapping constructor, puts SPC into DPC and the other way around
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Label to swap
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits
</TD></TR>
</TABLE></P>
<A NAME="SS7Label"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> (SS7PointCode::Type type, const SS7PointCode& dpc,
const SS7PointCode& opc, unsigned char sls, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Constructor from label components
</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">Type of point code used to pack the label
</TD></TR>
<TR><TD align="left" valign="top"><i>dpc</i></TD><TD align="left" valign="top">Destination Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>opc</i></TD><TD align="left" valign="top">Originating Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits
</TD></TR>
</TABLE></P>
<A NAME="SS7Label"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> (SS7PointCode::Type type, unsigned int dpc,
unsigned int opc, unsigned char sls, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Constructor from packed label components
</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">Type of point code used to pack the label
</TD></TR>
<TR><TD align="left" valign="top"><i>dpc</i></TD><TD align="left" valign="top">Destination Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>opc</i></TD><TD align="left" valign="top">Originating Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits
</TD></TR>
</TABLE></P>
<A NAME="SS7Label"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Label</strong> (SS7PointCode::Type type, const SS7MSU& msu)
<br></td><td align="right"><h3><strong>SS7Label</strong></h3></td></tr></table><p></p><p>
Constructor from type and received MSU
</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">Type of point code to use to decode the MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">A received MSU to be parsed
</TD></TR>
</TABLE></P>
<A NAME="assign"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>assign</strong> (SS7PointCode::Type type, const SS7PointCode& dpc,
const SS7PointCode& opc, unsigned char sls, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assignment from label components
</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">Type of point code used to pack the label
</TD></TR>
<TR><TD align="left" valign="top"><i>dpc</i></TD><TD align="left" valign="top">Destination Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>opc</i></TD><TD align="left" valign="top">Originating Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits
</TD></TR>
</TABLE></P>
<A NAME="assign"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>assign</strong> (SS7PointCode::Type type, unsigned int dpc,
unsigned int opc, unsigned char sls, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assignment from packed label components
</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">Type of point code used to pack the label
</TD></TR>
<TR><TD align="left" valign="top"><i>dpc</i></TD><TD align="left" valign="top">Destination Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>opc</i></TD><TD align="left" valign="top">Originating Point Code
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits
</TD></TR>
</TABLE></P>
<A NAME="assign"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>assign</strong> (SS7PointCode::Type type, const SS7MSU& msu)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assignment from type and received MSU
</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">Type of point code to use to decode the MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">A received MSU to be parsed
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the assignment succeeded
</p>
<A NAME="assign"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>assign</strong> (SS7PointCode::Type type, const unsigned char* src, int len = -1)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assignment from a packed memory block
</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">Type of the point codes in memory block
</TD></TR>
<TR><TD align="left" valign="top"><i>src</i></TD><TD align="left" valign="top">Pointer to packed label in memory
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of data, negative to not check validity
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if success, false if invalid type or memory area
</p>
<A NAME="store"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>store</strong> (unsigned char* dest)
<br></td><td align="right"><h3><strong>store</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Pack and store the label in a memory location
</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">Location to store the label info, must be at least length() long
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success, false if type is invalid
</p>
<A NAME="compatible"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>compatible</strong> (SS7PointCode::Type type)
<br></td><td align="right"><h3><strong>compatible</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the label is compatible with another packing type
</p>
<p><b>Returns</b>: True if the DLC, SLC and SLS fit in the new packing format
</p>
<A NAME="type"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SS7PointCode::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 (SS7 dialect) of the routing label
</p>
<p><b>Returns</b>: Dialect of the routing label as enumeration
</p>
<A NAME="dpc"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const SS7PointCode& <strong>dpc</strong> ()
<br></td><td align="right"><h3><strong>dpc</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the Destination Code Point inside the label
</p>
<p><b>Returns</b>: Reference of the destination code point
</p>
<A NAME="dpc"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SS7PointCode& <strong>dpc</strong> ()
<br></td><td align="right"><h3><strong>dpc</strong></h3></td></tr></table><p></p><p>
Get a writable reference to the Destination Code Point inside the label
</p>
<p><b>Returns</b>: Reference of the destination code point
</p>
<A NAME="opc"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const SS7PointCode& <strong>opc</strong> ()
<br></td><td align="right"><h3><strong>opc</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the Originating Code Point inside the label
</p>
<p><b>Returns</b>: Reference of the source code point
</p>
<A NAME="opc"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SS7PointCode& <strong>opc</strong> ()
<br></td><td align="right"><h3><strong>opc</strong></h3></td></tr></table><p></p><p>
Get a writable reference to the Originating Code Point inside the label
</p>
<p><b>Returns</b>: Reference of the originating code point
</p>
<A NAME="sls"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>sls</strong> ()
<br></td><td align="right"><h3><strong>sls</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the Signalling Link Selection inside the label
</p>
<p><b>Returns</b>: Value of the SLS field
</p>
<A NAME="setSls"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setSls</strong> (unsigned char sls)
<br></td><td align="right"><h3><strong>setSls</strong></h3></td></tr></table><p></p><p>
Set the Signalling Link Selection inside the label
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">New value of the SLS/SLC field
</TD></TR>
</TABLE></P>
<A NAME="spare"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>spare</strong> ()
<br></td><td align="right"><h3><strong>spare</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the spare bits inside the label
</p>
<p><b>Returns</b>: Value of the bits not included in DPC, OPC, or SLS
</p>
<A NAME="setSpare"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>setSpare</strong> (unsigned char spare)
<br></td><td align="right"><h3><strong>setSpare</strong></h3></td></tr></table><p></p><p>
Set the spare bits inside the label
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">New value of the spare bits
</TD></TR>
</TABLE></P>
<A NAME="length"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>length</strong> ()
<br></td><td align="right"><h3><strong>length</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the length (in bytes) of this routing label
</p>
<p><b>Returns</b>: Number of bytes required to represent the label, zero if unknown
</p>
<A NAME="length"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> unsigned int <strong>length</strong> (SS7PointCode::Type type)
<br></td><td align="right"><h3><strong>length</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the length (in bytes) of a packed routing label according to its 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">Type of the packing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Number of bytes required to represent the label, zero if unknown
</p>
<A NAME="size"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>size</strong> ()
<br></td><td align="right"><h3><strong>size</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the size (in bits) of this routing label except the spare bits
</p>
<p><b>Returns</b>: Number of bits required to represent this label, zero if unknown
</p>
<A NAME="size"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td> unsigned char <strong>size</strong> (SS7PointCode::Type type)
<br></td><td align="right"><h3><strong>size</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the size (in bits) of a packed routing label according to its 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">Type of the packing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Number of bits required to represent the label, zero if unknown
</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>
|
