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
|
<HTML>
<HEAD>
<TITLE>class SS7Layer3</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 SS7Layer3</h1>
</TD>
<TD valign="top" align="right" colspan="1">Abstract SS7 layer 3 (network) message transfer part. <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>::SS7Layer3</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__SignallingComponent.html">TelEngine::SignallingComponent</A> <small>[virtual public ]</small></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__SS7M3UA.html">SS7M3UA</A>, <A HREF="TelEngine__SS7MTP3.html">SS7MTP3</A>, <A HREF="TelEngine__SS7Router.html">SS7Router</A></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SS7Layer3.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 <b><A HREF="#ref2">~SS7Layer3</A></b> ()
</LI>
<LI>virtual int <b><i><A HREF="#ref3">transmitMSU</A></i></b> (const SS7MSU& msu, const SS7Label& label, int sls = -1)
</LI>
<LI>virtual bool <b><i><A HREF="#ref4">operational</A></i></b> (int sls = -1) const
</LI>
<LI>void <b><A HREF="#ref5">attach</A></b> (SS7L3User* l3user)
</LI>
<LI>inline SS7L3User* <b><A HREF="#ref6">user</A></b> () const
</LI>
<LI>SS7PointCode::Type <b><A HREF="#ref7">type</A></b> (unsigned char netType) const
</LI>
<LI>void <b><A HREF="#ref8">setType</A></b> (SS7PointCode::Type type, unsigned char netType)
</LI>
<LI>void <b><A HREF="#ref9">setType</A></b> (SS7PointCode::Type type)
</LI>
<LI>bool <b><A HREF="#ref10">buildRoutes</A></b> (const NamedList& params)
</LI>
<LI>unsigned int <b><A HREF="#ref11">getRoutePriority</A></b> (SS7PointCode::Type type, unsigned int packedPC)
</LI>
<LI>void <b><A HREF="#ref12">printRoutes</A></b> ()
</LI>
</ul><h4>Protected Methods</h4><ul><LI>inline <b><A HREF="#ref13">SS7Layer3</A></b> (SS7PointCode::Type type = SS7PointCode::Other)
</LI>
<LI>inline bool <b><A HREF="#ref14">receivedMSU</A></b> (const SS7MSU& msu, const SS7Label& label, int sls)
</LI>
<LI>inline void <b><A HREF="#ref15">notify</A></b> (int sls = -1)
</LI>
<LI>virtual bool <b><A HREF="#ref16">maintenance</A></b> (const SS7MSU& msu, const SS7Label& label, int sls)
</LI>
<LI>virtual bool <b><A HREF="#ref17">management</A></b> (const SS7MSU& msu, const SS7Label& label, int sls)
</LI>
<LI>virtual bool <b><A HREF="#ref18">unavailable</A></b> (const SS7MSU& msu, const SS7Label& label, int sls, unsigned char cause = 0)
</LI>
<LI>SS7Route* <b><A HREF="#ref19">findRoute</A></b> (SS7PointCode::Type type, unsigned int packed)
</LI>
<LI>void <b><A HREF="#ref20">updateRoutes</A></b> (SS7Layer3* network)
</LI>
<LI>void <b><A HREF="#ref21">removeRoutes</A></b> (SS7Layer3* network)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
An interface to a Layer 3 (network) SS7 message transfer part
</p>
<A NAME="~SS7Layer3"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SS7Layer3</strong> ()
<br></td><td align="right"><h3><strong>~SS7Layer3</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="transmitMSU"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <i><strong>transmitMSU</strong></i> (const SS7MSU& msu, const SS7Label& label, int sls = -1)
<br></td><td align="right"><h3><i><strong>transmitMSU</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p>
Push a Message Signal Unit down the protocol stack
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">Message data, starting with Service Indicator Octet
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Routing label of the MSU to use in routing
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link Selection, negative to choose best
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Link the message was successfully queued to, negative for error
</p>
<A NAME="operational"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <i><strong>operational</strong></i> (int sls = -1)
<br></td><td align="right"><h3><i><strong>operational</strong></i></h3></td></tr></table><p> <small>[const pure virtual]</small></p><p>
Check if the network/linkset is fully operational
</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">Signalling Link to check, negative to check if any is operational
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the linkset is enabled and operational
</p>
<A NAME="attach"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>attach</strong> (SS7L3User* l3user)
<br></td><td align="right"><h3><strong>attach</strong></h3></td></tr></table><p></p><p>
Attach a Layer 3 user component to this network. Detach the old user if valid.
Attach itself to the given user
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>l3user</i></TD><TD align="left" valign="top">Pointer to Layer 3 user component to attach
</TD></TR>
</TABLE></P>
<A NAME="user"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SS7L3User* <strong>user</strong> ()
<br></td><td align="right"><h3><strong>user</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the Layer 3 user component to which this network is attached
</p>
<p><b>Returns</b>: Pointer to the Layer 3 user this network is attached to
</p>
<A NAME="type"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SS7PointCode::Type <strong>type</strong> (unsigned char netType)
<br></td><td align="right"><h3><strong>type</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the point code type of this Layer 3 component for a MSU type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>netType</i></TD><TD align="left" valign="top">Type of the network like coded in the MSU NI field
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The type of codepoint this component will use
</p>
<A NAME="setType"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setType</strong> (SS7PointCode::Type type, unsigned char netType)
<br></td><td align="right"><h3><strong>setType</strong></h3></td></tr></table><p></p><p>
Set the point code of this Layer 3 component for a network 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">Point code type to set for the network type
</TD></TR>
<TR><TD align="left" valign="top"><i>netType</i></TD><TD align="left" valign="top">Type of the network like coded in the MSU NI field
</TD></TR>
</TABLE></P>
<A NAME="setType"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setType</strong> (SS7PointCode::Type type)
<br></td><td align="right"><h3><strong>setType</strong></h3></td></tr></table><p></p><p>
Set the point code of this Layer 3 component for all network types
</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">Point code type to set
</TD></TR>
</TABLE></P>
<A NAME="buildRoutes"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>buildRoutes</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>buildRoutes</strong></h3></td></tr></table><p></p><p>
Build the list of outgoing routes serviced by this network. Clear the list before re-building it.
This method is thread safe
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">The parameter list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if no route available
</p>
<A NAME="getRoutePriority"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>getRoutePriority</strong> (SS7PointCode::Type type, unsigned int packedPC)
<br></td><td align="right"><h3><strong>getRoutePriority</strong></h3></td></tr></table><p></p><p>
Get the priority of a route.
This method is thread safe
</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">Destination point code type
</TD></TR>
<TR><TD align="left" valign="top"><i>packedPC</i></TD><TD align="left" valign="top">The packed point code
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The priority of the route. -1 if no route to the given point code
</p>
<A NAME="printRoutes"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>printRoutes</strong> ()
<br></td><td align="right"><h3><strong>printRoutes</strong></h3></td></tr></table><p></p><p>
Print the destinations or routing table to output
</p>
<A NAME="SS7Layer3"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SS7Layer3</strong> (SS7PointCode::Type type = SS7PointCode::Other)
<br></td><td align="right"><h3><strong>SS7Layer3</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>type</i></TD><TD align="left" valign="top">Default point code type
</TD></TR>
</TABLE></P>
<A NAME="receivedMSU"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>receivedMSU</strong> (const SS7MSU& msu, const SS7Label& label, int sls)
<br></td><td align="right"><h3><strong>receivedMSU</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Push a received Message Signal Unit up the protocol stack
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">Message data, starting with Service Indicator Octet
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Routing label of the received MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link the MSU was received from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if message was successfully delivered to the user component
</p>
<A NAME="notify"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>notify</strong> (int sls = -1)
<br></td><td align="right"><h3><strong>notify</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Notify out user part about a status change
</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">Signallink Link that generated the notification, -1 if none
</TD></TR>
</TABLE></P>
<A NAME="maintenance"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>maintenance</strong> (const SS7MSU& msu, const SS7Label& label, int sls)
<br></td><td align="right"><h3><strong>maintenance</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Default processing of a MTN (Maintenance MSU)
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">Message data, starting with Service Indicator Octet
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Routing label of the received MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link the MSU was received from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the MSU was processed
</p>
<A NAME="management"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>management</strong> (const SS7MSU& msu, const SS7Label& label, int sls)
<br></td><td align="right"><h3><strong>management</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Default processing of a SNM (Management MSU)
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">Message data, starting with Service Indicator Octet
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Routing label of the received MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link the MSU was received from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the MSU was processed
</p>
<A NAME="unavailable"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>unavailable</strong> (const SS7MSU& msu, const SS7Label& label, int sls, unsigned char cause = 0)
<br></td><td align="right"><h3><strong>unavailable</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Default processing of an unknown MSU - emit an User Part Unavailable
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>msu</i></TD><TD align="left" valign="top">Message data, starting with Service Indicator Octet
</TD></TR>
<TR><TD align="left" valign="top"><i>label</i></TD><TD align="left" valign="top">Routing label of the received MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signalling Link the MSU was received from
</TD></TR>
<TR><TD align="left" valign="top"><i>cause</i></TD><TD align="left" valign="top">Unavailability cause code (Q.704 15.17.5)
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the MSU was processed
</p>
<A NAME="findRoute"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SS7Route* <strong>findRoute</strong> (SS7PointCode::Type type, unsigned int packed)
<br></td><td align="right"><h3><strong>findRoute</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Find a route having the specified point code type and packed point code.
This method is thread safe
</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">The point code type used to choose the list of packed point codes
</TD></TR>
<TR><TD align="left" valign="top"><i>packed</i></TD><TD align="left" valign="top">The packed point code to find in the list
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: SS7Route pointer or 0 if type is invalid or the given packed point code was not found
</p>
<A NAME="updateRoutes"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>updateRoutes</strong> (SS7Layer3* network)
<br></td><td align="right"><h3><strong>updateRoutes</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Add a network to the routing table. Clear all its routes before appending it to the table
Used by a SS7 router. This method is thread safe
</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">The network to add to the routing table
</TD></TR>
</TABLE></P>
<A NAME="removeRoutes"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>removeRoutes</strong> (SS7Layer3* network)
<br></td><td align="right"><h3><strong>removeRoutes</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Remove the given network from all destinations in the routing table.
Remove the entry in the routing table if empty (no more routes to the point code).
Used by a SS7 router. This method is thread safe
</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">The network to remove
</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>
|
