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
|
<!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: FaxReceive 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>FaxReceive Class Reference</h1>Call Module for receiving an analog fax (group 3).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="faxreceive_8h-source.html">faxreceive.h</a>></code>
<p>
<p>Inheritance diagram for FaxReceive:
<p><center><img src="classFaxReceive.png" usemap="#FaxReceive_map" border="0" alt=""></center>
<map name="FaxReceive_map">
<area href="classCallModule.html" alt="CallModule" shape="rect" coords="0,56,84,80">
<area href="classCallInterface.html" alt="CallInterface" shape="rect" coords="0,0,84,24">
</map>
<a href="classFaxReceive-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="classFaxReceive.html#a0">FaxReceive</a> (<a class="el" href="classConnection.html">Connection</a> *<a class="el" href="classCallModule.html#p3">conn</a>, string <a class="el" href="classFaxReceive.html#r0">file</a>) throw (CapiExternalError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Test if we are in fax mode and create an 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="classFaxReceive.html#a1">mainLoop</a> () throw (CapiWrongState, CapiExternalError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start file reception, wait for disconnect and stop the reception afterwards. <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="classFaxReceive.html#a2">transmissionComplete</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">finish main loop if file is completely received <a href="#a2"></a><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classFaxReceive.html#r0">file</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">file name to save file to <a href="#r0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call Module for receiving an analog fax (group 3).
<p>
This module handles the reception of an analog fax (fax group 3). It starts the reception and waits for the end of the connection.<p>
Fax polling isn't supported yet.<p>
Fax mode must have been established before using this (by connecting in fax mode or switching to fax with <a class="el" href="classSwitch2FaxG3.html">Switch2FaxG3</a>), otherwise an exception is caused.<p>
The created file will be saved in the format received by <a class="el" href="classCapi.html">Capi</a>, i.e. as Structured Fax File (SFF).<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="FaxReceive::FaxReceive" ></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"> FaxReceive::FaxReceive </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>string </td>
<td class="mdname" nowrap> <em>file</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> throw (<a class="el" href="classCapiExternalError.html">CapiExternalError</a>)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor. Test if we are in fax mode and create an 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>file</em> </td><td>name of file to save recorded stream to </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>CapiExternalError</em> </td><td>Thrown if we are not in fax mode.</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="FaxReceive::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 FaxReceive::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="classCapiWrongState.html">CapiWrongState</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>
Start file reception, wait for disconnect and stop the reception afterwards.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>CapiWrongState</em> </td><td>Thrown when disconnection takes place. </td></tr>
<tr><td></td><td valign=top><em>CapiExternalError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a6">Connection::start_file_reception</a>. See there for explanation.</td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a2">CallModule</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="FaxReceive::transmissionComplete" ></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 FaxReceive::transmissionComplete </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 main loop if file is completely received
<p>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a3">CallModule</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="r0" doxytag="FaxReceive::file" ></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"> string <a class="el" href="classFaxReceive.html#r0">FaxReceive::file</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
file name to save file to
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="faxreceive_8h-source.html">faxreceive.h</a><li>faxreceive.cpp</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>
|
