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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CapiSuite: DisconnectModule Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.8 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>DisconnectModule Class Reference</h1>Call Module for call clearing.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="disconnectmodule_8h-source.html">disconnectmodule.h</a>></code>
<p>
<p>Inheritance diagram for DisconnectModule:
<p><center><img src="classDisconnectModule.png" usemap="#DisconnectModule_map" border="0" alt=""></center>
<map name="DisconnectModule_map">
<area href="classCallModule.html" alt="CallModule" shape="rect" coords="0,56,117,80">
<area href="classCallInterface.html" alt="CallInterface" shape="rect" coords="0,0,117,24">
</map>
<a href="classDisconnectModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#a0">DisconnectModule</a> (<a class="el" href="classConnection.html">Connection</a> *<a class="el" href="classCallModule.html#p3">conn</a>, int <a class="el" href="classDisconnectModule.html#r0">reject_reason</a>=1, bool <a class="el" href="classDisconnectModule.html#r1">quick_disconnect</a>=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Create object. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#a1">mainLoop</a> () throw (CapiMsgError,CapiExternalError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate call clearing and wait for successful physical disconnection. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#a2">callDisconnectedLogical</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do nothing as we're waiting for physical disconnection. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#a3">callDisconnectedPhysical</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish current module if physical connection is cleared. <a href="#a3"></a><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#r0">reject_reason</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">saving reject reason given in constructor <a href="#r0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classDisconnectModule.html#r1">quick_disconnect</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">disconnect physical immediately w/o disconnection logical before <a href="#r1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call Module for call clearing.
<p>
This module initiates disconnection or rejection of connection and waits until the physical connection is cleared completely. It's no problem to call it when the connection is already (partly or completely) cleared.<p>
<dl compact><dt><b>Author:</b></dt><dd>Gernot Hillier </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="DisconnectModule::DisconnectModule" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> DisconnectModule::DisconnectModule </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classConnection.html">Connection</a> * </td>
<td class="mdname" nowrap> <em>conn</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>reject_reason</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>quick_disconnect</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor. Create object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>conn</em> </td><td>reference to <a class="el" href="classConnection.html">Connection</a> object </td></tr>
<tr><td></td><td valign=top><em>reject_reason</em> </td><td>reason to give for rejecting a waiting call (1=ignore call, default; for other values see <a class="el" href="classConnection.html#a10">Connection::rejectWaiting()</a>), ignored for normal disconnect </td></tr>
<tr><td></td><td valign=top><em>quick_disconnect</em> </td><td>disconnect physical immediately, this will lead to a protocol error in Layer 3. Use for error cases.</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="DisconnectModule::callDisconnectedLogical" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void DisconnectModule::callDisconnectedLogical </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Do nothing as we're waiting for physical disconnection.
<p>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a6">CallModule</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="DisconnectModule::callDisconnectedPhysical" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void DisconnectModule::callDisconnectedPhysical </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Finish current module if physical connection is cleared.
<p>
This is overwritten here because we don't trigger an exception at call clearing.
<p>
Reimplemented from <a class="el" href="classCallModule.html#a7">CallModule</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="DisconnectModule::mainLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void DisconnectModule::mainLoop </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classCapiMsgError.html">CapiMsgError</a>,<a class="el" href="classCapiExternalError.html">CapiExternalError</a>)<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initiate call clearing and wait for successful physical disconnection.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>CapiMsgError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a8">Connection::disconnectCall()</a> or <a class="el" href="classConnection.html#a10">Connection::rejectWaiting()</a> </td></tr>
<tr><td></td><td valign=top><em>CapiExternalError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a10">Connection::rejectWaiting()</a>.</td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a2">CallModule</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="r1" doxytag="DisconnectModule::quick_disconnect" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classDisconnectModule.html#r1">DisconnectModule::quick_disconnect</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
disconnect physical immediately w/o disconnection logical before
<p>
</td>
</tr>
</table>
<a class="anchor" name="r0" doxytag="DisconnectModule::reject_reason" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="classDisconnectModule.html#r0">DisconnectModule::reject_reason</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
saving reject reason given in constructor
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="disconnectmodule_8h-source.html">disconnectmodule.h</a><li><a class="el" href="disconnectmodule_8cpp.html">disconnectmodule.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 28 14:37:45 2004 for CapiSuite by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
