libs/beast/doc/html/beast/ref/boost__beast__http__read.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::read</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__parser/parser_dtor_.html" title="http::parser::~parser">
  10 <link rel="next" href="boost__beast__http__read/overload1.html" title="http::read (1 of 4 overloads)">
  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__parser/parser_dtor_.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__read/overload1.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__read"></a><a class="link" href="boost__beast__http__read.html" title="http::read">http::read</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873492838064"></a>
  31 Read a complete message from a stream using a parser.
  32       </p>
  33 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  34     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/SyncReadStream.html" target="_top"><span class="emphasis"><em>SyncReadStream</em></span></a><span class="special">,</span>
  35     <span class="keyword">class</span> <a class="link" href="../concepts/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">,</span>
  36     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">&gt;</span>
  37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  38 <a class="link" href="boost__beast__http__read/overload1.html" title="http::read (1 of 4 overloads)">read</a><span class="special">(</span>
  39     <span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  40     <span class="identifier">DynamicBuffer</span><span class="special">&amp;</span> <span class="identifier">buffer</span><span class="special">,</span>
  41     <span class="identifier">basic_parser</span><span class="special">&lt;</span> <span class="identifier">isRequest</span> <span class="special">&gt;&amp;</span> <span class="identifier">parser</span><span class="special">);</span>
  42   <span class="emphasis"><em>&#187; <a class="link" href="boost__beast__http__read/overload1.html" title="http::read (1 of 4 overloads)">more...</a></em></span>
  43
  44 <span class="keyword">template</span><span class="special">&lt;</span>
  45     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/SyncReadStream.html" target="_top"><span class="emphasis"><em>SyncReadStream</em></span></a><span class="special">,</span>
  46     <span class="keyword">class</span> <a class="link" href="../concepts/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">,</span>
  47     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">&gt;</span>
  48 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  49 <a class="link" href="boost__beast__http__read/overload2.html" title="http::read (2 of 4 overloads)">read</a><span class="special">(</span>
  50     <span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  51     <span class="identifier">DynamicBuffer</span><span class="special">&amp;</span> <span class="identifier">buffer</span><span class="special">,</span>
  52     <span class="identifier">basic_parser</span><span class="special">&lt;</span> <span class="identifier">isRequest</span> <span class="special">&gt;&amp;</span> <span class="identifier">parser</span><span class="special">,</span>
  53     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  54   <span class="emphasis"><em>&#187; <a class="link" href="boost__beast__http__read/overload2.html" title="http::read (2 of 4 overloads)">more...</a></em></span>
  55 </pre>
  56 <p>
  57         Read a complete message from a stream.
  58       </p>
  59 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  60     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/SyncReadStream.html" target="_top"><span class="emphasis"><em>SyncReadStream</em></span></a><span class="special">,</span>
  61     <span class="keyword">class</span> <a class="link" href="../concepts/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">,</span>
  62     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
  63     <span class="keyword">class</span> <a class="link" href="../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span>
  64     <span class="keyword">class</span> <a href="https://en.cppreference.com/w/cpp/named_req/Allocator" target="_top"><span class="emphasis"><em>Allocator</em></span></a><span class="special">&gt;</span>
  65 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  66 <a class="link" href="boost__beast__http__read/overload3.html" title="http::read (3 of 4 overloads)">read</a><span class="special">(</span>
  67     <span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  68     <span class="identifier">DynamicBuffer</span><span class="special">&amp;</span> <span class="identifier">buffer</span><span class="special">,</span>
  69     <span class="identifier">message</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">basic_fields</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;&gt;&amp;</span> <span class="identifier">msg</span><span class="special">);</span>
  70   <span class="emphasis"><em>&#187; <a class="link" href="boost__beast__http__read/overload3.html" title="http::read (3 of 4 overloads)">more...</a></em></span>
  71
  72 <span class="keyword">template</span><span class="special">&lt;</span>
  73     <span class="keyword">class</span> <a href="../../../../../../doc/html/boost_asio/reference/SyncReadStream.html" target="_top"><span class="emphasis"><em>SyncReadStream</em></span></a><span class="special">,</span>
  74     <span class="keyword">class</span> <a class="link" href="../concepts/DynamicBuffer.html" title="DynamicBuffer"><span class="emphasis"><em>DynamicBuffer</em></span></a><span class="special">,</span>
  75     <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
  76     <span class="keyword">class</span> <a class="link" href="../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span>
  77     <span class="keyword">class</span> <a href="https://en.cppreference.com/w/cpp/named_req/Allocator" target="_top"><span class="emphasis"><em>Allocator</em></span></a><span class="special">&gt;</span>
  78 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
  79 <a class="link" href="boost__beast__http__read/overload4.html" title="http::read (4 of 4 overloads)">read</a><span class="special">(</span>
  80     <span class="identifier">SyncReadStream</span><span class="special">&amp;</span> <span class="identifier">stream</span><span class="special">,</span>
  81     <span class="identifier">DynamicBuffer</span><span class="special">&amp;</span> <span class="identifier">buffer</span><span class="special">,</span>
  82     <span class="identifier">message</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">basic_fields</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;&gt;&amp;</span> <span class="identifier">msg</span><span class="special">,</span>
  83     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  84   <span class="emphasis"><em>&#187; <a class="link" href="boost__beast__http__read/overload4.html" title="http::read (4 of 4 overloads)">more...</a></em></span>
  85 </pre>
  86 </div>
  87 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  88 <td align="left"></td>
  89 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  90       Falco<p>
  91         Distributed under the Boost Software License, Version 1.0. (See accompanying
  92         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>)
  93       </p>
  94 </div></td>
  95 </tr></table>
  96 <hr>
  97 <div class="spirit-nav">
  98 <a accesskey="p" href="boost__beast__http__parser/parser_dtor_.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__read/overload1.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  99 </div>
 100 </body>
 101 </html>