Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > dc51c7d3f8a5588a609f484ef81504ee > files > 41

libfastcgipp-devel-1.1-2mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>fastcgi++: Fastcgipp::Fcgistream&lt; charT, traits &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</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>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceFastcgipp.html">Fastcgipp</a>::<a class="el" href="classFastcgipp_1_1Fcgistream.html">Fcgistream</a>
  </div>
</div>
<div class="contents">
<h1>Fastcgipp::Fcgistream&lt; charT, traits &gt; Class Template Reference</h1><!-- doxytag: class="Fastcgipp::Fcgistream" -->Stream class for output of client data through FastCGI.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>&gt;</code>
<p>

<p>
<a href="classFastcgipp_1_1Fcgistream-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream.html#23fa3ab4ecc0d9916d2a780b77b560b6">Fcgistream</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream.html#2340bdcaab24edbe7f3e97332d98ccab">set</a> (<a class="el" href="structFastcgipp_1_1Protocol_1_1FullId.html">Protocol::FullId</a> id_, <a class="el" href="classFastcgipp_1_1Transceiver.html">Transceiver</a> &amp;transceiver_, <a class="el" href="namespaceFastcgipp_1_1Protocol.html#79e41b489a9b2c0374eee108d375b646">Protocol::RecordType</a> type_)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Arguments passed directly to <a class="el" href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html#53d7707752aa2f3bb10e6fe27c0b3838" title="After construction constructor.">Fcgibuf::set()</a>.  <a href="#2340bdcaab24edbe7f3e97332d98ccab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream.html#ccf72ff881e5ef268aaabddae4ffd686">dump</a> (char *data, size_t size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dumps raw data directly into the FastCGI protocol.  <a href="#ccf72ff881e5ef268aaabddae4ffd686"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream.html#9eb452d9a72c44eac2561bc1afaa1b29">dump</a> (std::basic_istream&lt; char &gt; &amp;stream)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dumps an input stream directly into the FastCGI protocol.  <a href="#9eb452d9a72c44eac2561bc1afaa1b29"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html">Fcgibuf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream.html#292be828144e7aaa73bc4df553b2ac5a">buffer</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream buffer object.  <a href="#292be828144e7aaa73bc4df553b2ac5a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html">Fcgibuf</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream buffer class for output of client data through FastCGI.  <a href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class charT, class traits&gt;<br>
 class Fastcgipp::Fcgistream&lt; charT, traits &gt;</h3>

Stream class for output of client data through FastCGI. 
<p>
This class is derived from std::basic_ostream&lt;charT, traits&gt;. It acts just the same as any stream does with the added feature of the <a class="el" href="classFastcgipp_1_1Fcgistream.html#ccf72ff881e5ef268aaabddae4ffd686" title="Dumps raw data directly into the FastCGI protocol.">dump()</a> function.<p>
<dl compact><dt><b>Template Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>charT</em>&nbsp;</td><td>Character type (char or wchar_t) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>traits</em>&nbsp;</td><td>Character traits </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="fcgistream_8hpp-source.html#l00043">43</a> of file <a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="23fa3ab4ecc0d9916d2a780b77b560b6"></a><!-- doxytag: member="Fastcgipp::Fcgistream::Fcgistream" ref="23fa3ab4ecc0d9916d2a780b77b560b6" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class charT, class traits&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classFastcgipp_1_1Fcgistream.html">Fastcgipp::Fcgistream</a>&lt; charT, traits &gt;::<a class="el" href="classFastcgipp_1_1Fcgistream.html">Fcgistream</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="fcgistream_8hpp-source.html#l00046">46</a> of file <a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2340bdcaab24edbe7f3e97332d98ccab"></a><!-- doxytag: member="Fastcgipp::Fcgistream::set" ref="2340bdcaab24edbe7f3e97332d98ccab" args="(Protocol::FullId id_, Transceiver &amp;transceiver_, Protocol::RecordType type_)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class charT, class traits&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classFastcgipp_1_1Fcgistream.html">Fastcgipp::Fcgistream</a>&lt; charT, traits &gt;::set           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structFastcgipp_1_1Protocol_1_1FullId.html">Protocol::FullId</a>&nbsp;</td>
          <td class="paramname"> <em>id_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classFastcgipp_1_1Transceiver.html">Transceiver</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>transceiver_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceFastcgipp_1_1Protocol.html#79e41b489a9b2c0374eee108d375b646">Protocol::RecordType</a>&nbsp;</td>
          <td class="paramname"> <em>type_</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Arguments passed directly to <a class="el" href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html#53d7707752aa2f3bb10e6fe27c0b3838" title="After construction constructor.">Fcgibuf::set()</a>. 
<p>

<p>Definition at line <a class="el" href="fcgistream_8hpp-source.html#l00048">48</a> of file <a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>.</p>

<p>Referenced by <a class="el" href="classFastcgipp_1_1Request.html#d5dcbc6eb9e927f463a26c72957a87f8">Fastcgipp::Request&lt; charT &gt;::set()</a>.</p>

</div>
</div><p>
<a class="anchor" name="ccf72ff881e5ef268aaabddae4ffd686"></a><!-- doxytag: member="Fastcgipp::Fcgistream::dump" ref="ccf72ff881e5ef268aaabddae4ffd686" args="(char *data, size_t size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class charT, class traits&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classFastcgipp_1_1Fcgistream.html">Fastcgipp::Fcgistream</a>&lt; charT, traits &gt;::dump           </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Dumps raw data directly into the FastCGI protocol. 
<p>
This function exists as a mechanism to dump raw data out the stream bypassing the stream buffer or any code conversion mechanisms. If the user has any binary data to send, this is the function to do it with.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>data</em>&nbsp;</td><td>Pointer to first byte of data to send </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>size</em>&nbsp;</td><td>Size in bytes of data to be sent </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="fcgistream_8hpp-source.html#l00059">59</a> of file <a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>.</p>

<p>Referenced by <a class="el" href="classFastcgipp_1_1Fcgistream.html#9eb452d9a72c44eac2561bc1afaa1b29">Fastcgipp::Fcgistream&lt; charT, traits &gt;::dump()</a>.</p>

</div>
</div><p>
<a class="anchor" name="9eb452d9a72c44eac2561bc1afaa1b29"></a><!-- doxytag: member="Fastcgipp::Fcgistream::dump" ref="9eb452d9a72c44eac2561bc1afaa1b29" args="(std::basic_istream&lt; char &gt; &amp;stream)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class charT, class traits&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classFastcgipp_1_1Fcgistream.html">Fastcgipp::Fcgistream</a>&lt; charT, traits &gt;::dump           </td>
          <td>(</td>
          <td class="paramtype">std::basic_istream&lt; char &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Dumps an input stream directly into the FastCGI protocol. 
<p>
This function exists as a mechanism to dump a raw input stream out this stream bypassing the stream buffer or any code conversion mechanisms. Typically this would be a filestream associated with an image or something. The stream is transmitted until an EOF.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>stream</em>&nbsp;</td><td>Reference to input stream that should be transmitted. </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="request_8cpp-source.html#l00130">130</a> of file <a class="el" href="request_8cpp-source.html">request.cpp</a>.</p>

<p>References <a class="el" href="classFastcgipp_1_1Fcgistream.html#292be828144e7aaa73bc4df553b2ac5a">Fastcgipp::Fcgistream&lt; charT, traits &gt;::buffer</a>, and <a class="el" href="classFastcgipp_1_1Fcgistream.html#ccf72ff881e5ef268aaabddae4ffd686">Fastcgipp::Fcgistream&lt; charT, traits &gt;::dump()</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="292be828144e7aaa73bc4df553b2ac5a"></a><!-- doxytag: member="Fastcgipp::Fcgistream::buffer" ref="292be828144e7aaa73bc4df553b2ac5a" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class charT, class traits&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classFastcgipp_1_1Fcgistream_1_1Fcgibuf.html">Fcgibuf</a> <a class="el" href="classFastcgipp_1_1Fcgistream.html">Fastcgipp::Fcgistream</a>&lt; charT, traits &gt;::<a class="el" href="classFastcgipp_1_1Fcgistream.html#292be828144e7aaa73bc4df553b2ac5a">buffer</a><code> [private]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stream buffer object. 
<p>

<p>Definition at line <a class="el" href="fcgistream_8hpp-source.html#l00155">155</a> of file <a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a>.</p>

<p>Referenced by <a class="el" href="classFastcgipp_1_1Fcgistream.html#9eb452d9a72c44eac2561bc1afaa1b29">Fastcgipp::Fcgistream&lt; charT, traits &gt;::dump()</a>, <a class="el" href="classFastcgipp_1_1Fcgistream.html#ccf72ff881e5ef268aaabddae4ffd686">Fastcgipp::Fcgistream&lt; charT, std::char_traits&lt; charT &gt; &gt;::dump()</a>, and <a class="el" href="classFastcgipp_1_1Fcgistream.html#2340bdcaab24edbe7f3e97332d98ccab">Fastcgipp::Fcgistream&lt; charT, std::char_traits&lt; charT &gt; &gt;::set()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="fcgistream_8hpp-source.html">fcgistream.hpp</a><li><a class="el" href="request_8cpp-source.html">request.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 16 15:17:47 2008 for fastcgi++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>