<!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::WStreamResource 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.3</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_1WStreamResource.html">WStreamResource</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WStreamResource Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WStreamResource" --><!-- doxytag: inherits="Wt::WResource" -->
<p>An object which streams the data from a std::istream.
<a href="classWt_1_1WStreamResource.html#details">More...</a></p>
<p><code>#include <Wt/WStreamResource></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WStreamResource:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WStreamResource__inherit__graph.png" border="0" usemap="#Wt_1_1WStreamResource_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WStreamResource_inherit__map" id="Wt_1_1WStreamResource_inherit__map">
<area shape="rect" href="classWt_1_1WFileResource.html" title="A resource which streams the data from a local file." alt="" coords="15,229,151,256"/><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_1WStreamResource-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_1WStreamResource.html#ac826d0b1fa0eafb7b45af5693d1778f5">WStreamResource</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="#ac826d0b1fa0eafb7b45af5693d1778f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b08ceb7c773471a72da56c3cc775a96"></a><!-- doxytag: member="Wt::WStreamResource::WStreamResource" ref="a8b08ceb7c773471a72da56c3cc775a96" args="(const std::string &mimeType, WObject *parent=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#a8b08ceb7c773471a72da56c3cc775a96">WStreamResource</a> (const std::string &mimeType, <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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#afcdfc91f2660d58ba7d7c0424592d4e8">~WStreamResource</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#afcdfc91f2660d58ba7d7c0424592d4e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa25f97d38747be9451336422029bbde5"></a><!-- doxytag: member="Wt::WStreamResource::setMimeType" ref="aa25f97d38747be9451336422029bbde5" args="(const std::string &mimeType)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#aa25f97d38747be9451336422029bbde5">setMimeType</a> (const std::string &mimeType)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the mime-type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e19cf66c2221855be5c9bb2d1913342"></a><!-- doxytag: member="Wt::WStreamResource::mimeType" ref="a8e19cf66c2221855be5c9bb2d1913342" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#a8e19cf66c2221855be5c9bb2d1913342">mimeType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mime-type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#a016797af9eca9a2dc8000fac69946ec3">setBufferSize</a> (int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configures the buffer size. <a href="#a016797af9eca9a2dc8000fac69946ec3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#a2e8a8d6bd9c23b9650e22586e0e79224">bufferSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the buffer size. <a href="#a2e8a8d6bd9c23b9650e22586e0e79224"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WStreamResource.html#ab83350ee7a4a14ad06965145073b0293">handleRequestPiecewise</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, std::istream &input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles a request and streams the data from a std::istream. <a href="#ab83350ee7a4a14ad06965145073b0293"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An object which streams the data from a std::istream. </p>
<p>This class can be useful base for implementing resources which streams the data from std::istream derivatives.</p>
<p>The utility method <a class="el" href="classWt_1_1WStreamResource.html#ab83350ee7a4a14ad06965145073b0293" title="Handles a request and streams the data from a std::istream.">handleRequestPiecewise()</a> makes use of continuations to transmit data piecewise, without blocking a thread or requiring the whole data to be read in memory. The size of the buffer can be changed by using <a class="el" href="classWt_1_1WStreamResource.html#a016797af9eca9a2dc8000fac69946ec3" title="Configures the buffer size.">setBufferSize()</a>.</p>
<p>Example for a custom stream resource implementation: </p>
<div class="fragment"><pre class="fragment"><span class="keyword">class </span>MyStreamResource : <span class="keyword">public</span> Wt::<a class="code" href="classWt_1_1WStreamResource.html#ac826d0b1fa0eafb7b45af5693d1778f5" title="Default constructor.">WStreamResource</a>
{
<span class="keyword">public</span>:
MyStreamResource(<span class="keyword">const</span> std::string& fileName, <a class="code" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system.">Wt::WObject</a> *parent = 0)
: Wt::<a class="code" href="classWt_1_1WStreamResource.html#ac826d0b1fa0eafb7b45af5693d1778f5" title="Default constructor.">WStreamResource</a>(parent),
fileName_(fileName)
{
<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.txt"</span>);
}
~MyStreamResource() {
<a class="code" href="classWt_1_1WResource.html#a24f65859427f54012fef2fa9da14870d" title="Prepares the resource for deletion.">beingDeleted</a>();
}
<span class="keywordtype">void</span> <a class="code" href="classWt_1_1WResource.html#a3a740f8cc29e2e6e4e58defc9c88b8b6" title="Handles a request.">handleRequest</a>(<span class="keyword">const</span> <a class="code" href="classWt_1_1Http_1_1Request.html" title="A resource request.">Wt::Http::Request</a>& request,
<a class="code" href="classWt_1_1Http_1_1Response.html" title="A resource response.">Wt::Http::Response</a>& response) {
std::ifstream r(fileName_.c_str(), std::ios::in | std::ios::binary);
<a class="code" href="classWt_1_1WStreamResource.html#ab83350ee7a4a14ad06965145073b0293" title="Handles a request and streams the data from a std::istream.">handleRequestPiecewise</a>(request, response, r);
}
<span class="keyword">private</span>:
std::string fileName_;
};
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WFileResource.html" title="A resource which streams the data from a local file.">WFileResource</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac826d0b1fa0eafb7b45af5693d1778f5"></a><!-- doxytag: member="Wt::WStreamResource::WStreamResource" ref="ac826d0b1fa0eafb7b45af5693d1778f5" args="(WObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WStreamResource::WStreamResource </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>The mime type defaults to "text/plain". </p>
</div>
</div>
<a class="anchor" id="afcdfc91f2660d58ba7d7c0424592d4e8"></a><!-- doxytag: member="Wt::WStreamResource::~WStreamResource" ref="afcdfc91f2660d58ba7d7c0424592d4e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WStreamResource::~WStreamResource </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="a2e8a8d6bd9c23b9650e22586e0e79224"></a><!-- doxytag: member="Wt::WStreamResource::bufferSize" ref="a2e8a8d6bd9c23b9650e22586e0e79224" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::WStreamResource::bufferSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the buffer size. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WStreamResource.html#a016797af9eca9a2dc8000fac69946ec3" title="Configures the buffer size.">setBufferSize()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab83350ee7a4a14ad06965145073b0293"></a><!-- doxytag: member="Wt::WStreamResource::handleRequestPiecewise" ref="ab83350ee7a4a14ad06965145073b0293" args="(const Http::Request &request, Http::Response &response, std::istream &input)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WStreamResource::handleRequestPiecewise </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 class="paramkey"></td>
<td></td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>input</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a request and streams the data from a std::istream. </p>
<p>You can call this method from a custom <a class="el" href="classWt_1_1WResource.html#a3a740f8cc29e2e6e4e58defc9c88b8b6" title="Handles a request.">handleRequest()</a> implementations. </p>
</div>
</div>
<a class="anchor" id="a016797af9eca9a2dc8000fac69946ec3"></a><!-- doxytag: member="Wt::WStreamResource::setBufferSize" ref="a016797af9eca9a2dc8000fac69946ec3" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WStreamResource::setBufferSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configures the buffer size. </p>
<p>This configures the size of the buffer used to transmit the data piece by piece. </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 Thu Nov 1 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>
