libs/beast/doc/html/beast/ref/boost__beast__http__basic_parser/on_field_impl.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::basic_parser::on_field_impl</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__basic_parser.html" title="http::basic_parser">
   9 <link rel="prev" href="on_chunk_header_impl.html" title="http::basic_parser::on_chunk_header_impl">
  10 <link rel="next" href="on_finish_impl.html" title="http::basic_parser::on_finish_impl">
  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="on_chunk_header_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.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="on_finish_impl.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__basic_parser.on_field_impl"></a><a class="link" href="on_field_impl.html" title="http::basic_parser::on_field_impl">http::basic_parser::on_field_impl</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873502471280"></a>
  31 Called once for each complete field in the
  32           HTTP header.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.synopsis"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="keyword">void</span>
  39 <span class="identifier">on_field_impl</span><span class="special">(</span>
  40     <span class="identifier">field</span> <span class="identifier">name</span><span class="special">,</span>
  41     <span class="identifier">string_view</span> <span class="identifier">name_string</span><span class="special">,</span>
  42     <span class="identifier">string_view</span> <span class="identifier">value</span><span class="special">,</span>
  43     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  44 </pre>
  45 <h6>
  46 <a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h1"></a>
  47           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.description"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.description">Description</a>
  48         </h6>
  49 <p>
  50           This virtual function is invoked for each field that is received while
  51           parsing an HTTP message.
  52         </p>
  53 <h6>
  54 <a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.h2"></a>
  55           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_field_impl.parameters"></a></span><a class="link" href="on_field_impl.html#beast.ref.boost__beast__http__basic_parser.on_field_impl.parameters">Parameters</a>
  56         </h6>
  57 <div class="informaltable"><table class="table">
  58 <colgroup>
  59 <col>
  60 <col>
  61 </colgroup>
  62 <thead><tr>
  63 <th>
  64                   <p>
  65                     Name
  66                   </p>
  67                 </th>
  68 <th>
  69                   <p>
  70                     Description
  71                   </p>
  72                 </th>
  73 </tr></thead>
  74 <tbody>
  75 <tr>
  76 <td>
  77                   <p>
  78                     <code class="computeroutput"><span class="identifier">name</span></code>
  79                   </p>
  80                 </td>
  81 <td>
  82                   <p>
  83                     The known field enum value. If the name of the field is not recognized,
  84                     this value will be <a class="link" href="../boost__beast__http__field.html" title="http::field"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">unknown</span></code></a>.
  85                   </p>
  86                 </td>
  87 </tr>
  88 <tr>
  89 <td>
  90                   <p>
  91                     <code class="computeroutput"><span class="identifier">name_string</span></code>
  92                   </p>
  93                 </td>
  94 <td>
  95                   <p>
  96                     The exact name of the field as received from the input, represented
  97                     as a string.
  98                   </p>
  99                 </td>
 100 </tr>
 101 <tr>
 102 <td>
 103                   <p>
 104                     <code class="computeroutput"><span class="identifier">value</span></code>
 105                   </p>
 106                 </td>
 107 <td>
 108                   <p>
 109                     A string holding the value of the field.
 110                   </p>
 111                 </td>
 112 </tr>
 113 <tr>
 114 <td>
 115                   <p>
 116                     <code class="computeroutput"><span class="identifier">ec</span></code>
 117                   </p>
 118                 </td>
 119 <td>
 120                   <p>
 121                     An output parameter which the function may set to indicate an
 122                     error. The error will be clear before this function is invoked.
 123                   </p>
 124                 </td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </div>
 129 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 130 <td align="left"></td>
 131 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 132       Falco<p>
 133         Distributed under the Boost Software License, Version 1.0. (See accompanying
 134         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>)
 135       </p>
 136 </div></td>
 137 </tr></table>
 138 <hr>
 139 <div class="spirit-nav">
 140 <a accesskey="p" href="on_chunk_header_impl.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__basic_parser.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="on_finish_impl.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 141 </div>
 142 </body>
 143 </html>