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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::basic_parser::on_request_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_header_impl.html" title="http::basic_parser::on_header_impl">
  10 <link rel="next" href="on_response_impl.html" title="http::basic_parser::on_response_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_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_response_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_request_impl"></a><a class="link" href="on_request_impl.html" title="http::basic_parser::on_request_impl">http::basic_parser::on_request_impl</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873502377136"></a>
  31 Called after receiving the request-line.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.synopsis"></a></span><a class="link" href="on_request_impl.html#beast.ref.boost__beast__http__basic_parser.on_request_impl.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">on_request_impl</span><span class="special">(</span>
  39     <span class="identifier">verb</span> <span class="identifier">method</span><span class="special">,</span>
  40     <span class="identifier">string_view</span> <span class="identifier">method_str</span><span class="special">,</span>
  41     <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">,</span>
  42     <span class="keyword">int</span> <span class="identifier">version</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_request_impl.h1"></a>
  47           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.description"></a></span><a class="link" href="on_request_impl.html#beast.ref.boost__beast__http__basic_parser.on_request_impl.description">Description</a>
  48         </h6>
  49 <p>
  50           This virtual function is invoked after receiving a request-line when parsing
  51           HTTP requests. It can only be called when <code class="computeroutput"><span class="identifier">isRequest</span>
  52           <span class="special">==</span> <span class="keyword">true</span></code>.
  53         </p>
  54 <h6>
  55 <a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.h2"></a>
  56           <span class="phrase"><a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.parameters"></a></span><a class="link" href="on_request_impl.html#beast.ref.boost__beast__http__basic_parser.on_request_impl.parameters">Parameters</a>
  57         </h6>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 </colgroup>
  63 <thead><tr>
  64 <th>
  65                   <p>
  66                     Name
  67                   </p>
  68                 </th>
  69 <th>
  70                   <p>
  71                     Description
  72                   </p>
  73                 </th>
  74 </tr></thead>
  75 <tbody>
  76 <tr>
  77 <td>
  78                   <p>
  79                     <code class="computeroutput"><span class="identifier">method</span></code>
  80                   </p>
  81                 </td>
  82 <td>
  83                   <p>
  84                     The verb enumeration. If the method string is not one of the
  85                     predefined strings, 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>.
  86                   </p>
  87                 </td>
  88 </tr>
  89 <tr>
  90 <td>
  91                   <p>
  92                     <code class="computeroutput"><span class="identifier">method_str</span></code>
  93                   </p>
  94                 </td>
  95 <td>
  96                   <p>
  97                     The unmodified string representing the verb.
  98                   </p>
  99                 </td>
 100 </tr>
 101 <tr>
 102 <td>
 103                   <p>
 104                     <code class="computeroutput"><span class="identifier">target</span></code>
 105                   </p>
 106                 </td>
 107 <td>
 108                   <p>
 109                     The request-target.
 110                   </p>
 111                 </td>
 112 </tr>
 113 <tr>
 114 <td>
 115                   <p>
 116                     <code class="computeroutput"><span class="identifier">version</span></code>
 117                   </p>
 118                 </td>
 119 <td>
 120                   <p>
 121                     The HTTP-version. This will be 10 for HTTP/1.0, and 11 for HTTP/1.1.
 122                   </p>
 123                 </td>
 124 </tr>
 125 <tr>
 126 <td>
 127                   <p>
 128                     <code class="computeroutput"><span class="identifier">ec</span></code>
 129                   </p>
 130                 </td>
 131 <td>
 132                   <p>
 133                     An output parameter which the function may set to indicate an
 134                     error. The error will be clear before this function is invoked.
 135                   </p>
 136                 </td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 142 <td align="left"></td>
 143 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 144       Falco<p>
 145         Distributed under the Boost Software License, Version 1.0. (See accompanying
 146         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>)
 147       </p>
 148 </div></td>
 149 </tr></table>
 150 <hr>
 151 <div class="spirit-nav">
 152 <a accesskey="p" href="on_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_response_impl.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 153 </div>
 154 </body>
 155 </html>