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
|
<HTML>
<HEAD>
<TITLE>class SS7MTP3</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 SS7MTP3</h1>
</TD>
<TD valign="top" align="right" colspan="1">SS7 Layer 3 implementation on top of Layer 2. <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>::SS7MTP3</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__Mutex.html">TelEngine::Mutex</A> <small>[public ]</small>, <i><A HREF="TelEngine__SS7L2User.html">TelEngine::SS7L2User</A></i> <small>[public ]</small>, <i><A HREF="TelEngine__SS7Layer3.html">TelEngine::SS7Layer3</A></i> <small>[public ]</small>, <A HREF="TelEngine__SignallingDumpable.html">TelEngine::SignallingDumpable</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SS7MTP3.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="#ref1">Operation</A> { Pause = 0x100,
Resume = 0x200,
Status = 0x400,
}
</LI>
</ul><h4>Public Methods</h4><ul><LI> <b><A HREF="#ref2">SS7MTP3</A></b> (const NamedList& params)
</LI>
<LI>virtual <b><A HREF="#ref3">~SS7MTP3</A></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref4">initialize</A></b> (const NamedList* config)
</LI>
<LI>virtual int <b><A HREF="#ref5">transmitMSU</A></b> (const SS7MSU& msu, const SS7Label& label, int sls = -1)
</LI>
<LI>virtual bool <b><A HREF="#ref6">operational</A></b> (int sls = -1) const
</LI>
<LI>virtual bool <b><A HREF="#ref7">control</A></b> (Operation oper, NamedList* params = 0)
</LI>
<LI>virtual void <b><A HREF="#ref8">attach</A></b> (SS7Layer2* link)
</LI>
<LI>virtual void <b><A HREF="#ref9">detach</A></b> (SS7Layer2* link)
</LI>
<LI>virtual bool <b><A HREF="#ref10">control</A></b> (NamedList& params)
</LI>
<LI>inline unsigned int <b><A HREF="#ref11">linksTotal</A></b> () const
</LI>
<LI>inline unsigned int <b><A HREF="#ref12">linksActive</A></b> () const
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref13">destroyed</A></b> ()
</LI>
<LI>virtual bool <b><A HREF="#ref14">receivedMSU</A></b> (const SS7MSU& msu, SS7Layer2* link, int sls)
</LI>
<LI>virtual void <b><A HREF="#ref15">notify</A></b> (SS7Layer2* link)
</LI>
<LI>unsigned int <b><A HREF="#ref16">countLinks</A></b> ()
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Q.704 SS7 Layer 3 (Network) implementation on top of SS7 Layer 2
</p>
<A NAME="Operation"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Operation</strong> { Pause = 0x100,
Resume = 0x200,
Status = 0x400,
}
</td><td align="right"><h3><strong>Operation</strong></h3></td></tr></table><p></p><p>
Control primitives
</p>
<A NAME="SS7MTP3"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7MTP3</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>SS7MTP3</strong></h3></td></tr></table><p></p><p>
Constructor
</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">Layer's parameters
</TD></TR>
</TABLE></P>
<A NAME="~SS7MTP3"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SS7MTP3</strong> ()
<br></td><td align="right"><h3><strong>~SS7MTP3</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="initialize"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>initialize</strong> (const NamedList* config)
<br></td><td align="right"><h3><strong>initialize</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Configure and initialize the MTP3 and all its links
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>config</i></TD><TD align="left" valign="top">Optional configuration parameters override
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if MTP3 and at least one link were initialized properly
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#initialize">SignallingComponent</A>.</p>
<A NAME="transmitMSU"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> int <strong>transmitMSU</strong> (const SS7MSU& msu, const SS7Label& label, int sls = -1)
<br></td><td align="right"><h3><strong>transmitMSU</strong></h3></td></tr></table><p> <small>[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 used 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>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#transmitMSU">SS7Layer3</A>.</p>
<A NAME="operational"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>operational</strong> (int sls = -1)
<br></td><td align="right"><h3><strong>operational</strong></h3></td></tr></table><p> <small>[const 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>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#operational">SS7Layer3</A>.</p>
<A NAME="control"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>control</strong> (Operation oper, NamedList* params = 0)
<br></td><td align="right"><h3><strong>control</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Execute a control operation on the linkset
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>oper</i></TD><TD align="left" valign="top">Operation to execute
</TD></TR>
<TR><TD align="left" valign="top"><i>params</i></TD><TD align="left" valign="top">Optional parameters for the operation
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the command completed successfully, for query operations
also indicates the linkset is enabled and operational
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#control">SignallingComponent</A>.</p>
<A NAME="attach"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>attach</strong> (SS7Layer2* link)
<br></td><td align="right"><h3><strong>attach</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Attach a SS7 Layer 2 (data link) to the network transport. Attach itself to the link
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>link</i></TD><TD align="left" valign="top">Pointer to data link to attach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#attach">SS7Layer3</A>.</p>
<A NAME="detach"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>detach</strong> (SS7Layer2* link)
<br></td><td align="right"><h3><strong>detach</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Detach a SS7 Layer 2 (data link) from the network transport. Remove the link's L2 user
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>link</i></TD><TD align="left" valign="top">Pointer to data link to detach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#detach">SignallingComponent</A>.</p>
<A NAME="control"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>control</strong> (NamedList& params)
<br></td><td align="right"><h3><strong>control</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Query or modify layer's settings or operational parameters
</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 list of parameters to query or change
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the control operation was executed
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#control">SignallingComponent</A>.</p>
<A NAME="linksTotal"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>linksTotal</strong> ()
<br></td><td align="right"><h3><strong>linksTotal</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the total number of links attached
</p>
<p><b>Returns</b>: Number of attached data links
</p>
<A NAME="linksActive"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>linksActive</strong> ()
<br></td><td align="right"><h3><strong>linksActive</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the number of links that are currently operational
</p>
<p><b>Returns</b>: Number of operational data links
</p>
<A NAME="destroyed"></A><A NAME="ref13"></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>
Detach all links and user. Destroys the object, disposes the memory
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#destroyed">SignallingComponent</A>.</p>
<A NAME="receivedMSU"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>receivedMSU</strong> (const SS7MSU& msu, SS7Layer2* link, int sls)
<br></td><td align="right"><h3><strong>receivedMSU</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Process a MSU received from the Layer 2 component
</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>link</i></TD><TD align="left" valign="top">Data link that delivered the 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>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#receivedMSU">SS7Layer3</A>.</p>
<A NAME="notify"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>notify</strong> (SS7Layer2* link)
<br></td><td align="right"><h3><strong>notify</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Process a notification generated by the attached data link
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>link</i></TD><TD align="left" valign="top">Data link that generated the notification
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if notification was processed
</p>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#notify">SS7Layer3</A>.</p>
<A NAME="countLinks"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>countLinks</strong> ()
<br></td><td align="right"><h3><strong>countLinks</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Count the total and active number of links
</p>
<p><b>Returns</b>: Number of active links
</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>
|
