• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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 1. Boost.Beast">
8<link rel="up" href="../boost__beast__http__basic_parser.html" title="http::basic_parser">
9<link rel="prev" href="operator_eq_/overload2.html" title="http::basic_parser::operator= (2 of 2 overloads)">
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="operator_eq_/overload2.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="idm46057547398512"></a>
31        </p>
32<p>
33          Called after receiving the request-line.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.h0"></a>
37          <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>
38        </h6>
39<pre class="programlisting"><span class="keyword">void</span>
40<span class="identifier">on_request_impl</span><span class="special">(</span>
41    <span class="identifier">verb</span> <span class="identifier">method</span><span class="special">,</span>
42    <span class="identifier">string_view</span> <span class="identifier">method_str</span><span class="special">,</span>
43    <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">,</span>
44    <span class="keyword">int</span> <span class="identifier">version</span><span class="special">,</span>
45    <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
46</pre>
47<h6>
48<a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.h1"></a>
49          <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>
50        </h6>
51<p>
52          This virtual function is invoked after receiving a request-line when parsing
53          HTTP requests. It can only be called when <code class="computeroutput"><span class="identifier">isRequest</span>
54          <span class="special">==</span> <span class="keyword">true</span></code>.
55        </p>
56<h6>
57<a name="beast.ref.boost__beast__http__basic_parser.on_request_impl.h2"></a>
58          <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>
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">method</span></code>
82                  </p>
83                </td>
84<td>
85                  <p>
86                    The verb enumeration. If the method string is not one of the
87                    predefined strings, this value will be <a class="link" href="../boost__beast__http__field.html" title="http::field"><code class="computeroutput"><span class="identifier">verb</span><span class="special">::</span><span class="identifier">unknown</span></code></a>.
88                  </p>
89                </td>
90</tr>
91<tr>
92<td>
93                  <p>
94                    <code class="computeroutput"><span class="identifier">method_str</span></code>
95                  </p>
96                </td>
97<td>
98                  <p>
99                    The unmodified string representing the verb.
100                  </p>
101                </td>
102</tr>
103<tr>
104<td>
105                  <p>
106                    <code class="computeroutput"><span class="identifier">target</span></code>
107                  </p>
108                </td>
109<td>
110                  <p>
111                    The request-target.
112                  </p>
113                </td>
114</tr>
115<tr>
116<td>
117                  <p>
118                    <code class="computeroutput"><span class="identifier">version</span></code>
119                  </p>
120                </td>
121<td>
122                  <p>
123                    The HTTP-version. This will be 10 for HTTP/1.0, and 11 for HTTP/1.1.
124                  </p>
125                </td>
126</tr>
127<tr>
128<td>
129                  <p>
130                    <code class="computeroutput"><span class="identifier">ec</span></code>
131                  </p>
132                </td>
133<td>
134                  <p>
135                    An output parameter which the function may set to indicate an
136                    error. The error will be clear before this function is invoked.
137                  </p>
138                </td>
139</tr>
140</tbody>
141</table></div>
142</div>
143<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
144<td align="left"></td>
145<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
146      Falco<p>
147        Distributed under the Boost Software License, Version 1.0. (See accompanying
148        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>)
149      </p>
150</div></td>
151</tr></table>
152<hr>
153<div class="spirit-nav">
154<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__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>
155</div>
156</body>
157</html>
158