libs/beast/doc/html/beast/ref/boost__beast__http__message/payload_size.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::message::payload_size</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__message.html" title="http::message">
   9 <link rel="prev" href="operator_eq_/overload2.html" title="http::message::operator= (2 of 2 overloads)">
  10 <link rel="next" href="prepare_payload.html" title="http::message::prepare_payload">
  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="operator_eq_/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__message.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="prepare_payload.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__message.payload_size"></a><a class="link" href="payload_size.html" title="http::message::payload_size">http::message::payload_size</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873495062336"></a>
  31 Returns the payload size of the body in octets
  32           if possible.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__http__message.payload_size.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__http__message.payload_size.synopsis"></a></span><a class="link" href="payload_size.html#beast.ref.boost__beast__http__message.payload_size.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="special">&gt;</span>
  39 <span class="identifier">payload_size</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
  40 </pre>
  41 <h6>
  42 <a name="beast.ref.boost__beast__http__message.payload_size.h1"></a>
  43           <span class="phrase"><a name="beast.ref.boost__beast__http__message.payload_size.description"></a></span><a class="link" href="payload_size.html#beast.ref.boost__beast__http__message.payload_size.description">Description</a>
  44         </h6>
  45 <p>
  46           This function invokes the <span class="emphasis"><em>Body</em></span> algorithm to measure
  47           the number of octets in the serialized body container. If there is no body,
  48           this will return zero. Otherwise, if the body exists but is not known ahead
  49           of time, <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">none</span></code> is returned (usually indicating
  50           that a chunked Transfer-Encoding will be used).
  51         </p>
  52 <h6>
  53 <a name="beast.ref.boost__beast__http__message.payload_size.h2"></a>
  54           <span class="phrase"><a name="beast.ref.boost__beast__http__message.payload_size.remarks"></a></span><a class="link" href="payload_size.html#beast.ref.boost__beast__http__message.payload_size.remarks">Remarks</a>
  55         </h6>
  56 <p>
  57           The value of the Content-Length field in the message is not inspected.
  58         </p>
  59 </div>
  60 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  61 <td align="left"></td>
  62 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  63       Falco<p>
  64         Distributed under the Boost Software License, Version 1.0. (See accompanying
  65         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>)
  66       </p>
  67 </div></td>
  68 </tr></table>
  69 <hr>
  70 <div class="spirit-nav">
  71 <a accesskey="p" href="operator_eq_/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__message.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="prepare_payload.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  72 </div>
  73 </body>
  74 </html>