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
286
287
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::WFileResource Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WFileResource.html">WFileResource</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WFileResource Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WFileResource" --><!-- doxytag: inherits="Wt::WStreamResource" -->
<p>A resource which streams the data from a local file.
<a href="classWt_1_1WFileResource.html#details">More...</a></p>
<p><code>#include <Wt/WFileResource></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WFileResource:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WFileResource__inherit__graph.png" border="0" usemap="#Wt_1_1WFileResource_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WFileResource_inherit__map" id="Wt_1_1WFileResource_inherit__map">
<area shape="rect" href="classWt_1_1WStreamResource.html" title="An object which streams the data from a std::istream." alt="" coords="5,155,160,181"/><area shape="rect" href="classWt_1_1WResource.html" title="An object which can be rendered in the HTTP protocol." alt="" coords="25,80,140,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="35,5,131,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WFileResource-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#a61cd3c164de338e8c750a4e852c85109">WFileResource</a> (<a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a61cd3c164de338e8c750a4e852c85109"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#a3ba8b11f98f8404f41f2721f94ef9260">WFileResource</a> (const std::string &fileName, <a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new resource for a file. <a href="#a3ba8b11f98f8404f41f2721f94ef9260"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab756e5ea65534bfa89dccfc1bd1ce06d"></a><!-- doxytag: member="Wt::WFileResource::WFileResource" ref="ab756e5ea65534bfa89dccfc1bd1ce06d" args="(const std::string &mimeType, const std::string &fileName, WObject *parent=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#ab756e5ea65534bfa89dccfc1bd1ce06d">WFileResource</a> (const std::string &mimeType, const std::string &fileName, <a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new resource with given mime-type for a file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#a60bcdd2873274df4143c79444d178004">~WFileResource</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a60bcdd2873274df4143c79444d178004"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#a02a899ebef188895c4f1707e529c0ef3">setFileName</a> (const std::string &fileName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a (different) filename. <a href="#a02a899ebef188895c4f1707e529c0ef3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeec71fb64b2a1bef2ebb7f61f30639e3"></a><!-- doxytag: member="Wt::WFileResource::fileName" ref="aeec71fb64b2a1bef2ebb7f61f30639e3" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#aeec71fb64b2a1bef2ebb7f61f30639e3">fileName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the filename. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WFileResource.html#a7a801fa115d455a2b8cc29938a29fe85">handleRequest</a> (const <a class="el" href="classWt_1_1Http_1_1Request.html">Http::Request</a> &request, <a class="el" href="classWt_1_1Http_1_1Response.html">Http::Response</a> &response)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a request. <a href="#a7a801fa115d455a2b8cc29938a29fe85"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A resource which streams the data from a local file. </p>
<p>To update the resource, either use <a class="el" href="classWt_1_1WFileResource.html#a02a899ebef188895c4f1707e529c0ef3" title="Sets a (different) filename.">setFileName()</a> to point it to a new file, or emit the <a class="el" href="classWt_1_1WResource.html#a1527418354a584790c372e86a40c6027" title="Signal emitted when the data presented in this resource has changed.">WResource::dataChanged()</a> signal when only the file contents has changed, but not the filename.</p>
<p>The resource makes use of continuations to transmit data piecewise, without blocking a thread or requiring the entire file to be read in memory. The size of the buffer can be changed using <a class="el" href="classWt_1_1WStreamResource.html#a016797af9eca9a2dc8000fac69946ec3" title="Configures the buffer size.">setBufferSize()</a>.</p>
<p>Usage examples: </p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WFileResource.html" title="A resource which streams the data from a local file.">Wt::WFileResource</a> *csvFile = <span class="keyword">new</span> <a class="code" href="classWt_1_1WFileResource.html#a61cd3c164de338e8c750a4e852c85109" title="Default constructor.">Wt::WFileResource</a>(<span class="stringliteral">"text/csv"</span>, <span class="stringliteral">"/opt/files/afile.csv"</span>);
csvFile-><a class="code" href="classWt_1_1WResource.html#a30a0736f36f44b2a47ab25e9aa164851" title="Suggests a filename to the user for the data streamed by this resource.">suggestFileName</a>(<span class="stringliteral">"data.csv"</span>);
<a class="code" href="classWt_1_1WAnchor.html" title="A widget that represents an HTML anchor (to link to other documents).">Wt::WAnchor</a> *anchor = <span class="keyword">new</span> <a class="code" href="classWt_1_1WAnchor.html" title="A widget that represents an HTML anchor (to link to other documents).">Wt::WAnchor</a>(csvFile, <span class="stringliteral">"CSV data"</span>);
<a class="code" href="classWt_1_1WFileResource.html" title="A resource which streams the data from a local file.">Wt::WFileResource</a> *imageFile = <span class="keyword">new</span> <a class="code" href="classWt_1_1WFileResource.html#a61cd3c164de338e8c750a4e852c85109" title="Default constructor.">Wt::WFileResource</a>(<span class="stringliteral">"image/png"</span>, <span class="stringliteral">"/opt/files/image.png"</span>);
imageFile-><a class="code" href="classWt_1_1WResource.html#a30a0736f36f44b2a47ab25e9aa164851" title="Suggests a filename to the user for the data streamed by this resource.">suggestFileName</a>(<span class="stringliteral">"data.png"</span>);
<a class="code" href="classWt_1_1WImage.html" title="A widget that displays an image.">Wt::WImage</a> *image = <span class="keyword">new</span> <a class="code" href="classWt_1_1WImage.html" title="A widget that displays an image.">Wt::WImage</a>(imageFile, <span class="stringliteral">"PNG version"</span>);
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WStreamResource.html" title="An object which streams the data from a std::istream.">WStreamResource</a>, <a class="el" href="classWt_1_1WMemoryResource.html" title="A resource which streams data from memory.">WMemoryResource</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a61cd3c164de338e8c750a4e852c85109"></a><!-- doxytag: member="Wt::WFileResource::WFileResource" ref="a61cd3c164de338e8c750a4e852c85109" args="(WObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WFileResource::WFileResource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html">WObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>You need to set a file name (and mime type) for the resource using <a class="el" href="classWt_1_1WFileResource.html#a02a899ebef188895c4f1707e529c0ef3" title="Sets a (different) filename.">setFileName()</a> and <a class="el" href="classWt_1_1WStreamResource.html#aa25f97d38747be9451336422029bbde5" title="Sets the mime-type.">setMimeType()</a>. </p>
</div>
</div>
<a class="anchor" id="a3ba8b11f98f8404f41f2721f94ef9260"></a><!-- doxytag: member="Wt::WFileResource::WFileResource" ref="a3ba8b11f98f8404f41f2721f94ef9260" args="(const std::string &fileName, WObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WFileResource::WFileResource </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html">WObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new resource for a file. </p>
<p>The mime type defaults to "text/plain". </p>
</div>
</div>
<a class="anchor" id="a60bcdd2873274df4143c79444d178004"></a><!-- doxytag: member="Wt::WFileResource::~WFileResource" ref="a60bcdd2873274df4143c79444d178004" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WFileResource::~WFileResource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>It is up to the user to make sure that the resource is no longer in use (by e.g. a <a class="el" href="classWt_1_1WImage.html" title="A widget that displays an image.">WImage</a>). </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7a801fa115d455a2b8cc29938a29fe85"></a><!-- doxytag: member="Wt::WFileResource::handleRequest" ref="a7a801fa115d455a2b8cc29938a29fe85" args="(const Http::Request &request, Http::Response &response)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WFileResource::handleRequest </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Http_1_1Request.html">Http::Request</a> & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1Http_1_1Response.html">Http::Response</a> & </td>
<td class="paramname"><em>response</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a request. </p>
<p>Reimplement this method so that a proper response is generated for the given request. From the <code>request</code> object you can access request parameters and whether the request is a continuation request. In the <code>response</code> object, you should set the mime type and stream the output data.</p>
<p>A request may also concern a continuation, indicated in <a class="el" href="classWt_1_1Http_1_1Request.html#a2d4f88961a222be846460a8238823ae0" title="Returns a continuation object.">Http::Request::continuation()</a>, in which case the next part for a previously created continuation should be served.</p>
<p>While handling a request, which may happen at any time together with event handling, the library makes sure that the resource is not being concurrently deleted, but multiple requests may happend simultaneously for a single resource. </p>
<p>Implements <a class="el" href="classWt_1_1WResource.html#a3a740f8cc29e2e6e4e58defc9c88b8b6">Wt::WResource</a>.</p>
</div>
</div>
<a class="anchor" id="a02a899ebef188895c4f1707e529c0ef3"></a><!-- doxytag: member="Wt::WFileResource::setFileName" ref="a02a899ebef188895c4f1707e529c0ef3" args="(const std::string &fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WFileResource::setFileName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a (different) filename. </p>
<p>Set the location of the file on the local filesystem which must be streamed for this resource. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Fri Mar 30 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
|
