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
|
<HTML>
<HEAD>
<TITLE>class SS7Router</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 SS7Router</h1>
</TD>
<TD valign="top" align="right" colspan="1">Main router for SS7 message transfer and applications. <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>::SS7Router</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__SS7L3User.html">TelEngine::SS7L3User</A></i> <small>[public ]</small>, <i><A HREF="TelEngine__SS7Layer3.html">TelEngine::SS7Layer3</A></i> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SS7Router.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">SS7Router</A></b> (const NamedList& params)
</LI>
<LI>virtual bool <b><A HREF="#ref2">initialize</A></b> (const NamedList* config)
</LI>
<LI>virtual int <b><A HREF="#ref3">transmitMSU</A></b> (const SS7MSU& msu, const SS7Label& label, int sls = -1)
</LI>
<LI>virtual bool <b><A HREF="#ref4">operational</A></b> (int sls = -1) const
</LI>
<LI>virtual void <b><A HREF="#ref5">attach</A></b> (SS7Layer3* network)
</LI>
<LI>virtual void <b><A HREF="#ref6">detach</A></b> (SS7Layer3* network)
</LI>
<LI>void <b><A HREF="#ref7">attach</A></b> (SS7Layer4* service)
</LI>
<LI>void <b><A HREF="#ref8">detach</A></b> (SS7Layer4* service)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual bool <b><A HREF="#ref9">receivedMSU</A></b> (const SS7MSU& msu, const SS7Label& label, SS7Layer3* network, int sls)
</LI>
<LI>virtual void <b><A HREF="#ref10">notify</A></b> (SS7Layer3* network, int sls)
</LI>
</ul><h4>Protected Members</h4><ul><LI>ObjList <b><A HREF="#ref11">m_layer3</A></b></LI>
<LI>ObjList <b><A HREF="#ref12">m_layer4</A></b></LI>
<LI>int <b><A HREF="#ref13">m_changes</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A message router between Transfer and Application layers.
Messages are distributed according to the service type.
</p>
<A NAME="SS7Router"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SS7Router</strong> (const NamedList& params)
<br></td><td align="right"><h3><strong>SS7Router</strong></h3></td></tr></table><p></p><p>
Default 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">The list with the parameters
</TD></TR>
</TABLE></P>
<A NAME="initialize"></A><A NAME="ref2"></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 router, maintenance and management
</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 the router was initialized properly
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#initialize">SignallingComponent</A>.</p>
<A NAME="transmitMSU"></A><A NAME="ref3"></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 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>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#transmitMSU">SS7Layer3</A>.</p>
<A NAME="operational"></A><A NAME="ref4"></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 router 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 router is enabled and operational
</p>
<p>Reimplemented from <A HREF="TelEngine__SS7Layer3.html#operational">SS7Layer3</A>.</p>
<A NAME="attach"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>attach</strong> (SS7Layer3* network)
<br></td><td align="right"><h3><strong>attach</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Attach a SS7 Layer 3 (network) to the router. Attach the router to the given network
</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">Pointer to network to attach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SS7L3User.html#attach">SS7L3User</A>.</p>
<A NAME="detach"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>detach</strong> (SS7Layer3* network)
<br></td><td align="right"><h3><strong>detach</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Detach a SS7 Layer 3 (network) from the router. Detach the router from the given network
</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">Pointer to network to detach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#detach">SignallingComponent</A>.</p>
<A NAME="attach"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>attach</strong> (SS7Layer4* service)
<br></td><td align="right"><h3><strong>attach</strong></h3></td></tr></table><p></p><p>
Attach a SS7 Layer 4 (service) to the router. Attach itself to the service
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>service</i></TD><TD align="left" valign="top">Pointer to service to attach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SS7L3User.html#attach">SS7L3User</A>.</p>
<A NAME="detach"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>detach</strong> (SS7Layer4* service)
<br></td><td align="right"><h3><strong>detach</strong></h3></td></tr></table><p></p><p>
Detach a SS7 Layer 4 (service) from the router. Detach itself from the service
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>service</i></TD><TD align="left" valign="top">Pointer to service to detach
</TD></TR>
</TABLE></P>
<p>Reimplemented from <A HREF="TelEngine__SignallingComponent.html#detach">SignallingComponent</A>.</p>
<A NAME="receivedMSU"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>receivedMSU</strong> (const SS7MSU& msu, const SS7Label& label, SS7Layer3* network, 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 3 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>label</i></TD><TD align="left" valign="top">Routing label of the received MSU
</TD></TR>
<TR><TD align="left" valign="top"><i>network</i></TD><TD align="left" valign="top">Network layer 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__SS7L3User.html#receivedMSU">SS7L3User</A>.</p>
<A NAME="notify"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>notify</strong> (SS7Layer3* network, int sls)
<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 network layer
</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">Network or linkset that generated the notification
</TD></TR>
<TR><TD align="left" valign="top"><i>sls</i></TD><TD align="left" valign="top">Signallink Link that generated the notification, negative if none
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if notification was processed
</p>
<p>Reimplemented from <A HREF="TelEngine__SS7L3User.html#notify">SS7L3User</A>.</p>
<A NAME="m_layer3"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList <strong>m_layer3</strong>
</td><td align="right"><h3><strong>m_layer3</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_layer4"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList <strong>m_layer4</strong>
</td><td align="right"><h3><strong>m_layer4</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_changes"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_changes</strong>
</td><td align="right"><h3><strong>m_changes</strong></h3></td></tr></table><p> <small>[protected]</small></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>
|
