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