libs/beast/doc/html/beast/ref/boost__beast__http__string_body.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::string_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__status_class.html" title="http::status_class">
  10 <link rel="next" href="boost__beast__http__string_to_field.html" title="http::string_to_field">
  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__status_class.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__string_to_field.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__string_body"></a><a class="link" href="boost__beast__http__string_body.html" title="http::string_body">http::string_body</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873489946576"></a>
  31 A <span class="emphasis"><em>Body</em></span> using <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span></code>
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__http__string_body.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__http__string_body.synopsis"></a></span><a class="link" href="boost__beast__http__string_body.html#beast.ref.boost__beast__http__string_body.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/string_body.hpp" target="_top">boost/beast/http/string_body.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">string_body</span> <span class="special">=</span> <span class="identifier">basic_string_body</span><span class="special">&lt;</span> <span class="keyword">char</span> <span class="special">&gt;;</span>
  41 </pre>
  42 <h5>
  43 <a name="beast.ref.boost__beast__http__string_body.h1"></a>
  44         <span class="phrase"><a name="beast.ref.boost__beast__http__string_body.types"></a></span><a class="link" href="boost__beast__http__string_body.html#beast.ref.boost__beast__http__string_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_string_body/reader.html" title="http::basic_string_body::reader"><span class="bold"><strong>reader</strong></span></a>
  68                 </p>
  69               </td>
  70 <td>
  71                 <p>
  72                   The algorithm for parsing the body.
  73                 </p>
  74               </td>
  75 </tr>
  76 <tr>
  77 <td>
  78                 <p>
  79                   <a class="link" href="boost__beast__http__basic_string_body/value_type.html" title="http::basic_string_body::value_type"><span class="bold"><strong>value_type</strong></span></a>
  80                 </p>
  81               </td>
  82 <td>
  83                 <p>
  84                   The type of container used for the body.
  85                 </p>
  86               </td>
  87 </tr>
  88 <tr>
  89 <td>
  90                 <p>
  91                   <a class="link" href="boost__beast__http__basic_string_body/writer.html" title="http::basic_string_body::writer"><span class="bold"><strong>writer</strong></span></a>
  92                 </p>
  93               </td>
  94 <td>
  95                 <p>
  96                   The algorithm for serializing the body.
  97                 </p>
  98               </td>
  99 </tr>
 100 </tbody>
 101 </table></div>
 102 <h5>
 103 <a name="beast.ref.boost__beast__http__string_body.h2"></a>
 104         <span class="phrase"><a name="beast.ref.boost__beast__http__string_body.member_functions"></a></span><a class="link" href="boost__beast__http__string_body.html#beast.ref.boost__beast__http__string_body.member_functions">Member
 105         Functions</a>
 106       </h5>
 107 <div class="informaltable"><table class="table">
 108 <colgroup>
 109 <col>
 110 <col>
 111 </colgroup>
 112 <thead><tr>
 113 <th>
 114                 <p>
 115                   Name
 116                 </p>
 117               </th>
 118 <th>
 119                 <p>
 120                   Description
 121                 </p>
 122               </th>
 123 </tr></thead>
 124 <tbody><tr>
 125 <td>
 126                 <p>
 127                   <a class="link" href="boost__beast__http__basic_string_body/size.html" title="http::basic_string_body::size"><span class="bold"><strong>size</strong></span></a>
 128                 </p>
 129               </td>
 130 <td>
 131                 <p>
 132                   Returns the payload size of the body.
 133                 </p>
 134               </td>
 135 </tr></tbody>
 136 </table></div>
 137 <p>
 138         This body uses <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span></code> as a memory-based container
 139         for holding message payloads. Messages using this body type may be serialized
 140         and parsed.
 141       </p>
 142 <h5>
 143 <a name="beast.ref.boost__beast__http__string_body.h3"></a>
 144         <span class="phrase"><a name="beast.ref.boost__beast__http__string_body.description"></a></span><a class="link" href="boost__beast__http__string_body.html#beast.ref.boost__beast__http__string_body.description">Description</a>
 145       </h5>
 146 <p>
 147         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 148       </p>
 149 </div>
 150 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 151 <td align="left"></td>
 152 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 153       Falco<p>
 154         Distributed under the Boost Software License, Version 1.0. (See accompanying
 155         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>)
 156       </p>
 157 </div></td>
 158 </tr></table>
 159 <hr>
 160 <div class="spirit-nav">
 161 <a accesskey="p" href="boost__beast__http__status_class.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__string_to_field.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 162 </div>
 163 </body>
 164 </html>