• 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::message::method (2 of 2 overloads)</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="../method.html" title="http::message::method">
9<link rel="prev" href="overload1.html" title="http::message::method (1 of 2 overloads)">
10<link rel="next" href="../method_string.html" title="http::message::method_string">
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="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method.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="../method_string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h6 class="title">
27<a name="beast.ref.boost__beast__http__message.method.overload2"></a><a class="link" href="overload2.html" title="http::message::method (2 of 2 overloads)">http::message::method
28          (2 of 2 overloads)</a>
29</h6></div></div></div>
30<p>
31            (Inherited from <a class="link" href="../../boost__beast__http__header.html" title="http::header"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">header</span></code></a>)
32          </p>
33<p>
34            Set the request-method.
35          </p>
36<h7><a name="beast.ref.boost__beast__http__message.method.overload2.h0"></a>
37            <span class="phrase"><a name="beast.ref.boost__beast__http__message.method.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__message.method.overload2.synopsis">Synopsis</a>
38          </h7><pre class="programlisting"><span class="keyword">void</span>
39<span class="identifier">method</span><span class="special">(</span>
40    <span class="identifier">verb</span> <span class="identifier">v</span><span class="special">);</span>
41</pre>
42<h7><a name="beast.ref.boost__beast__http__message.method.overload2.h1"></a>
43            <span class="phrase"><a name="beast.ref.boost__beast__http__message.method.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__message.method.overload2.description">Description</a>
44          </h7><p>
45            This function will set the method for requests to a known verb.
46          </p>
47<h7><a name="beast.ref.boost__beast__http__message.method.overload2.h2"></a>
48            <span class="phrase"><a name="beast.ref.boost__beast__http__message.method.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__message.method.overload2.parameters">Parameters</a>
49          </h7><div class="informaltable"><table class="table">
50<colgroup>
51<col>
52<col>
53</colgroup>
54<thead><tr>
55<th>
56                    <p>
57                      Name
58                    </p>
59                  </th>
60<th>
61                    <p>
62                      Description
63                    </p>
64                  </th>
65</tr></thead>
66<tbody><tr>
67<td>
68                    <p>
69                      <code class="computeroutput"><span class="identifier">v</span></code>
70                    </p>
71                  </td>
72<td>
73                    <p>
74                      The request method verb to set. This may not 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>.
75                    </p>
76                  </td>
77</tr></tbody>
78</table></div>
79<h7><a name="beast.ref.boost__beast__http__message.method.overload2.h3"></a>
80            <span class="phrase"><a name="beast.ref.boost__beast__http__message.method.overload2.exceptions"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__message.method.overload2.exceptions">Exceptions</a>
81          </h7><div class="informaltable"><table class="table">
82<colgroup>
83<col>
84<col>
85</colgroup>
86<thead><tr>
87<th>
88                    <p>
89                      Type
90                    </p>
91                  </th>
92<th>
93                    <p>
94                      Thrown On
95                    </p>
96                  </th>
97</tr></thead>
98<tbody><tr>
99<td>
100                    <p>
101                      <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">invalid_argument</span></code>
102                    </p>
103                  </td>
104<td>
105                    <p>
106                      when v == <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>.
107                    </p>
108                  </td>
109</tr></tbody>
110</table></div>
111<h7><a name="beast.ref.boost__beast__http__message.method.overload2.h4"></a>
112            <span class="phrase"><a name="beast.ref.boost__beast__http__message.method.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__message.method.overload2.remarks">Remarks</a>
113          </h7><p>
114            This function is only available when <code class="computeroutput"><span class="identifier">isRequest</span>
115            <span class="special">==</span> <span class="keyword">true</span></code>.
116          </p>
117</div>
118<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
119<td align="left"></td>
120<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
121      Falco<p>
122        Distributed under the Boost Software License, Version 1.0. (See accompanying
123        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>)
124      </p>
125</div></td>
126</tr></table>
127<hr>
128<div class="spirit-nav">
129<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../method.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="../method_string.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
130</div>
131</body>
132</html>
133