libs/beast/doc/html/beast/ref/boost__beast__http__file_body.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::file_body</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__http__fields.html" title="http::fields">
  10 <link rel="next" href="boost__beast__http__header.html" title="http::header">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="boost__beast__http__fields.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__http__header.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__http__file_body"></a><a class="link" href="boost__beast__http__file_body.html" title="http::file_body">http::file_body</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873498514240"></a>
  31 A message body represented by a file on the filesystem.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__http__file_body.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__http__file_body.synopsis"></a></span><a class="link" href="boost__beast__http__file_body.html#beast.ref.boost__beast__http__file_body.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/file_body.hpp" target="_top">boost/beast/http/file_body.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">file_body</span> <span class="special">=</span> <span class="identifier">basic_file_body</span><span class="special">&lt;</span> <span class="identifier">file</span> <span class="special">&gt;;</span>
  41 </pre>
  42 <h5>
  43 <a name="beast.ref.boost__beast__http__file_body.h1"></a>
  44         <span class="phrase"><a name="beast.ref.boost__beast__http__file_body.types"></a></span><a class="link" href="boost__beast__http__file_body.html#beast.ref.boost__beast__http__file_body.types">Types</a>
  45       </h5>
  46 <div class="informaltable"><table class="table">
  47 <colgroup>
  48 <col>
  49 <col>
  50 </colgroup>
  51 <thead><tr>
  52 <th>
  53                 <p>
  54                   Name
  55                 </p>
  56               </th>
  57 <th>
  58                 <p>
  59                   Description
  60                 </p>
  61               </th>
  62 </tr></thead>
  63 <tbody>
  64 <tr>
  65 <td>
  66                 <p>
  67                   <a class="link" href="boost__beast__http__basic_file_body__reader.html" title="http::basic_file_body::reader"><span class="bold"><strong>reader</strong></span></a>
  68                 </p>
  69               </td>
  70 <td>
  71                 <p>
  72                   Algorithm for storing buffers when parsing.
  73                 </p>
  74               </td>
  75 </tr>
  76 <tr>
  77 <td>
  78                 <p>
  79                   <a class="link" href="boost__beast__http__basic_file_body__value_type.html" title="http::basic_file_body::value_type"><span class="bold"><strong>value_type</strong></span></a>
  80                 </p>
  81               </td>
  82 <td>
  83                 <p>
  84                   The type of the message::body member.
  85                 </p>
  86               </td>
  87 </tr>
  88 <tr>
  89 <td>
  90                 <p>
  91                   <a class="link" href="boost__beast__http__basic_file_body__writer.html" title="http::basic_file_body::writer"><span class="bold"><strong>writer</strong></span></a>
  92                 </p>
  93               </td>
  94 <td>
  95                 <p>
  96                   Algorithm for retrieving buffers when serializing.
  97                 </p>
  98               </td>
  99 </tr>
 100 <tr>
 101 <td>
 102                 <p>
 103                   <a class="link" href="boost__beast__http__basic_file_body/file_type.html" title="http::basic_file_body::file_type"><span class="bold"><strong>file_type</strong></span></a>
 104                 </p>
 105               </td>
 106 <td>
 107                 <p>
 108                   The type of File this body uses.
 109                 </p>
 110               </td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 <h5>
 115 <a name="beast.ref.boost__beast__http__file_body.h2"></a>
 116         <span class="phrase"><a name="beast.ref.boost__beast__http__file_body.member_functions"></a></span><a class="link" href="boost__beast__http__file_body.html#beast.ref.boost__beast__http__file_body.member_functions">Member
 117         Functions</a>
 118       </h5>
 119 <div class="informaltable"><table class="table">
 120 <colgroup>
 121 <col>
 122 <col>
 123 </colgroup>
 124 <thead><tr>
 125 <th>
 126                 <p>
 127                   Name
 128                 </p>
 129               </th>
 130 <th>
 131                 <p>
 132                   Description
 133                 </p>
 134               </th>
 135 </tr></thead>
 136 <tbody><tr>
 137 <td>
 138                 <p>
 139                   <a class="link" href="boost__beast__http__basic_file_body/size.html" title="http::basic_file_body::size"><span class="bold"><strong>size</strong></span></a>
 140                 </p>
 141               </td>
 142 <td>
 143                 <p>
 144                   Returns the size of the body.
 145                 </p>
 146               </td>
 147 </tr></tbody>
 148 </table></div>
 149 <p>
 150         Messages with this type have bodies represented by a file on the file system.
 151         When parsing a message using this body type, the data is stored in the file
 152         pointed to by the path, which must be writable. When serializing, the implementation
 153         will read the file and present those octets as the body content. This may
 154         be used to serve content from a directory as part of a web service.
 155       </p>
 156 <h5>
 157 <a name="beast.ref.boost__beast__http__file_body.h3"></a>
 158         <span class="phrase"><a name="beast.ref.boost__beast__http__file_body.template_parameters"></a></span><a class="link" href="boost__beast__http__file_body.html#beast.ref.boost__beast__http__file_body.template_parameters">Template
 159         Parameters</a>
 160       </h5>
 161 <div class="informaltable"><table class="table">
 162 <colgroup>
 163 <col>
 164 <col>
 165 </colgroup>
 166 <thead><tr>
 167 <th>
 168                 <p>
 169                   Type
 170                 </p>
 171               </th>
 172 <th>
 173                 <p>
 174                   Description
 175                 </p>
 176               </th>
 177 </tr></thead>
 178 <tbody><tr>
 179 <td>
 180                 <p>
 181                   <code class="computeroutput"><span class="identifier">File</span></code>
 182                 </p>
 183               </td>
 184 <td>
 185                 <p>
 186                   The implementation to use for accessing files. This type must meet
 187                   the requirements of <span class="emphasis"><em>File</em></span>.
 188                 </p>
 189               </td>
 190 </tr></tbody>
 191 </table></div>
 192 <h5>
 193 <a name="beast.ref.boost__beast__http__file_body.h4"></a>
 194         <span class="phrase"><a name="beast.ref.boost__beast__http__file_body.description"></a></span><a class="link" href="boost__beast__http__file_body.html#beast.ref.boost__beast__http__file_body.description">Description</a>
 195       </h5>
 196 <p>
 197         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 198       </p>
 199 </div>
 200 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 201 <td align="left"></td>
 202 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 203       Falco<p>
 204         Distributed under the Boost Software License, Version 1.0. (See accompanying
 205         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 206       </p>
 207 </div></td>
 208 </tr></table>
 209 <hr>
 210 <div class="spirit-nav">
 211 <a accesskey="p" href="boost__beast__http__fields.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__http__header.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 212 </div>
 213 </body>
 214 </html>