libs/beast/doc/html/beast/ref/boost__beast__http__serializer/next.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::serializer::next</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="../boost__beast__http__serializer.html" title="http::serializer">
   9 <link rel="prev" href="limit/overload2.html" title="http::serializer::limit (2 of 2 overloads)">
  10 <link rel="next" href="operator_eq_.html" title="http::serializer::operator=">
  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="limit/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__serializer.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="operator_eq_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__http__serializer.next"></a><a class="link" href="next.html" title="http::serializer::next">http::serializer::next</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873490649056"></a>
  31 Returns the next set of buffers in the serialization.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__serializer.next.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.next.synopsis"></a></span><a class="link" href="next.html#beast.ref.boost__beast__http__serializer.next.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  38     <span class="keyword">class</span> <span class="identifier">Visit</span><span class="special">&gt;</span>
  39 <span class="keyword">void</span>
  40 <span class="identifier">next</span><span class="special">(</span>
  41     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
  42     <span class="identifier">Visit</span><span class="special">&amp;&amp;</span> <span class="identifier">visit</span><span class="special">);</span>
  43 </pre>
  44 <h6>
  45 <a name="beast.ref.boost__beast__http__serializer.next.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.next.description"></a></span><a class="link" href="next.html#beast.ref.boost__beast__http__serializer.next.description">Description</a>
  47         </h6>
  48 <p>
  49           This function will attempt to call the <code class="computeroutput"><span class="identifier">visit</span></code>
  50           function object with a <span class="emphasis"><em>ConstBufferSequence</em></span> of unspecified
  51           type representing the next set of buffers in the serialization of the message
  52           represented by this object. If there are no more buffers in the serialization,
  53           the visit function will not be called. In this case, no error will be indicated,
  54           and the function <a class="link" href="is_done.html" title="http::serializer::is_done"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">is_done</span></code></a> will return <code class="computeroutput"><span class="keyword">true</span></code>.
  55         </p>
  56 <h6>
  57 <a name="beast.ref.boost__beast__http__serializer.next.h2"></a>
  58           <span class="phrase"><a name="beast.ref.boost__beast__http__serializer.next.parameters"></a></span><a class="link" href="next.html#beast.ref.boost__beast__http__serializer.next.parameters">Parameters</a>
  59         </h6>
  60 <div class="informaltable"><table class="table">
  61 <colgroup>
  62 <col>
  63 <col>
  64 </colgroup>
  65 <thead><tr>
  66 <th>
  67                   <p>
  68                     Name
  69                   </p>
  70                 </th>
  71 <th>
  72                   <p>
  73                     Description
  74                   </p>
  75                 </th>
  76 </tr></thead>
  77 <tbody>
  78 <tr>
  79 <td>
  80                   <p>
  81                     <code class="computeroutput"><span class="identifier">ec</span></code>
  82                   </p>
  83                 </td>
  84 <td>
  85                   <p>
  86                     Set to the error, if any occurred.
  87                   </p>
  88                 </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                   <p>
  93                     <code class="computeroutput"><span class="identifier">visit</span></code>
  94                   </p>
  95                 </td>
  96 <td>
  97                   <p>
  98                     The function to call. The equivalent function signature of this
  99                     object must be:
 100                   </p>
 101 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">ConstBufferSequence</span><span class="special">&gt;</span>
 102 <span class="keyword">void</span> <span class="identifier">visit</span><span class="special">(</span><span class="identifier">error_code</span><span class="special">&amp;,</span> <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;);</span>
 103 </pre>
 104                   <p>
 105                     The function is not copied, if no error occurs it will be invoked
 106                     before the call to <a class="link" href="next.html" title="http::serializer::next"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">next</span></code></a> returns.
 107                   </p>
 108                 </td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 </div>
 113 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 114 <td align="left"></td>
 115 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 116       Falco<p>
 117         Distributed under the Boost Software License, Version 1.0. (See accompanying
 118         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>)
 119       </p>
 120 </div></td>
 121 </tr></table>
 122 <hr>
 123 <div class="spirit-nav">
 124 <a accesskey="p" href="limit/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__serializer.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="operator_eq_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 125 </div>
 126 </body>
 127 </html>