• 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::verb</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="../ref.html" title="This Page Intentionally Left Blank 2/2">
9<link rel="prev" href="boost__beast__http__status_class.html" title="http::status_class">
10<link rel="next" href="boost__beast__http__chunk_extensions.html" title="http::chunk_extensions">
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="boost__beast__http__status_class.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__chunk_extensions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="beast.ref.boost__beast__http__verb"></a><a class="link" href="boost__beast__http__verb.html" title="http::verb">http::verb</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057509268272"></a>
31      </p>
32<p>
33        HTTP request method verbs.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__http__verb.h0"></a>
37        <span class="phrase"><a name="beast.ref.boost__beast__http__verb.synopsis"></a></span><a class="link" href="boost__beast__http__verb.html#beast.ref.boost__beast__http__verb.synopsis">Synopsis</a>
38      </h5>
39<p>
40        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/verb.hpp" target="_top">boost/beast/http/verb.hpp</a>&gt;</code>
41      </p>
42<pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">verb</span>
43</pre>
44<h5>
45<a name="beast.ref.boost__beast__http__verb.h1"></a>
46        <span class="phrase"><a name="beast.ref.boost__beast__http__verb.values"></a></span><a class="link" href="boost__beast__http__verb.html#beast.ref.boost__beast__http__verb.values">Values</a>
47      </h5>
48<div class="informaltable"><table class="table">
49<colgroup>
50<col>
51<col>
52</colgroup>
53<thead><tr>
54<th>
55                <p>
56                  Name
57                </p>
58              </th>
59<th>
60                <p>
61                  Description
62                </p>
63              </th>
64</tr></thead>
65<tbody>
66<tr>
67<td>
68                <p>
69                  <code class="computeroutput"><span class="identifier">unknown</span></code>
70                </p>
71              </td>
72<td>
73                <p>
74                  An unknown method.
75                </p>
76                <p>
77                  This value indicates that the request method string is not one
78                  of the recognized verbs. Callers interested in the method should
79                  use an interface which returns the original string.
80                </p>
81              </td>
82</tr>
83<tr>
84<td>
85                <p>
86                  <code class="computeroutput"><span class="identifier">delete_</span></code>
87                </p>
88              </td>
89<td>
90                <p>
91                  The DELETE method deletes the specified resource.
92                </p>
93              </td>
94</tr>
95<tr>
96<td>
97                <p>
98                  <code class="computeroutput"><span class="identifier">get</span></code>
99                </p>
100              </td>
101<td>
102                <p>
103                  The GET method requests a representation of the specified resource.
104                </p>
105                <p>
106                  Requests using GET should only retrieve data and should have no
107                  other effect.
108                </p>
109              </td>
110</tr>
111<tr>
112<td>
113                <p>
114                  <code class="computeroutput"><span class="identifier">head</span></code>
115                </p>
116              </td>
117<td>
118                <p>
119                  The HEAD method asks for a response identical to that of a GET
120                  request, but without the response body.
121                </p>
122                <p>
123                  This is useful for retrieving meta-information written in response
124                  headers, without having to transport the entire content.
125                </p>
126              </td>
127</tr>
128<tr>
129<td>
130                <p>
131                  <code class="computeroutput"><span class="identifier">post</span></code>
132                </p>
133              </td>
134<td>
135                <p>
136                  The POST method requests that the server accept the entity enclosed
137                  in the request as a new subordinate of the web resource identified
138                  by the URI.
139                </p>
140                <p>
141                  The data POSTed might be, for example, an annotation for existing
142                  resources; a message for a bulletin board, newsgroup, mailing list,
143                  or comment thread; a block of data that is the result of submitting
144                  a web form to a data-handling process; or an item to add to a database
145                </p>
146              </td>
147</tr>
148<tr>
149<td>
150                <p>
151                  <code class="computeroutput"><span class="identifier">put</span></code>
152                </p>
153              </td>
154<td>
155                <p>
156                  The PUT method requests that the enclosed entity be stored under
157                  the supplied URI.
158                </p>
159                <p>
160                  If the URI refers to an already existing resource, it is modified;
161                  if the URI does not point to an existing resource, then the server
162                  can create the resource with that URI.
163                </p>
164              </td>
165</tr>
166<tr>
167<td>
168                <p>
169                  <code class="computeroutput"><span class="identifier">connect</span></code>
170                </p>
171              </td>
172<td>
173                <p>
174                  The CONNECT method converts the request connection to a transparent
175                  TCP/IP tunnel.
176                </p>
177                <p>
178                  This is usually to facilitate SSL-encrypted communication (HTTPS)
179                  through an unencrypted HTTP proxy.
180                </p>
181              </td>
182</tr>
183<tr>
184<td>
185                <p>
186                  <code class="computeroutput"><span class="identifier">options</span></code>
187                </p>
188              </td>
189<td>
190                <p>
191                  The OPTIONS method returns the HTTP methods that the server supports
192                  for the specified URL.
193                </p>
194                <p>
195                  This can be used to check the functionality of a web server by
196                  requesting '*' instead of a specific resource.
197                </p>
198              </td>
199</tr>
200<tr>
201<td>
202                <p>
203                  <code class="computeroutput"><span class="identifier">trace</span></code>
204                </p>
205              </td>
206<td>
207                <p>
208                  The TRACE method echoes the received request so that a client can
209                  see what (if any) changes or additions have been made by intermediate
210                  servers.
211                </p>
212              </td>
213</tr>
214<tr>
215<td>
216                <p>
217                  <code class="computeroutput"><span class="identifier">copy</span></code>
218                </p>
219              </td>
220<td>
221              </td>
222</tr>
223<tr>
224<td>
225                <p>
226                  <code class="computeroutput"><span class="identifier">lock</span></code>
227                </p>
228              </td>
229<td>
230              </td>
231</tr>
232<tr>
233<td>
234                <p>
235                  <code class="computeroutput"><span class="identifier">mkcol</span></code>
236                </p>
237              </td>
238<td>
239              </td>
240</tr>
241<tr>
242<td>
243                <p>
244                  <code class="computeroutput"><span class="identifier">move</span></code>
245                </p>
246              </td>
247<td>
248              </td>
249</tr>
250<tr>
251<td>
252                <p>
253                  <code class="computeroutput"><span class="identifier">propfind</span></code>
254                </p>
255              </td>
256<td>
257              </td>
258</tr>
259<tr>
260<td>
261                <p>
262                  <code class="computeroutput"><span class="identifier">proppatch</span></code>
263                </p>
264              </td>
265<td>
266              </td>
267</tr>
268<tr>
269<td>
270                <p>
271                  <code class="computeroutput"><span class="identifier">search</span></code>
272                </p>
273              </td>
274<td>
275              </td>
276</tr>
277<tr>
278<td>
279                <p>
280                  <code class="computeroutput"><span class="identifier">unlock</span></code>
281                </p>
282              </td>
283<td>
284              </td>
285</tr>
286<tr>
287<td>
288                <p>
289                  <code class="computeroutput"><span class="identifier">bind</span></code>
290                </p>
291              </td>
292<td>
293              </td>
294</tr>
295<tr>
296<td>
297                <p>
298                  <code class="computeroutput"><span class="identifier">rebind</span></code>
299                </p>
300              </td>
301<td>
302              </td>
303</tr>
304<tr>
305<td>
306                <p>
307                  <code class="computeroutput"><span class="identifier">unbind</span></code>
308                </p>
309              </td>
310<td>
311              </td>
312</tr>
313<tr>
314<td>
315                <p>
316                  <code class="computeroutput"><span class="identifier">acl</span></code>
317                </p>
318              </td>
319<td>
320              </td>
321</tr>
322<tr>
323<td>
324                <p>
325                  <code class="computeroutput"><span class="identifier">report</span></code>
326                </p>
327              </td>
328<td>
329              </td>
330</tr>
331<tr>
332<td>
333                <p>
334                  <code class="computeroutput"><span class="identifier">mkactivity</span></code>
335                </p>
336              </td>
337<td>
338              </td>
339</tr>
340<tr>
341<td>
342                <p>
343                  <code class="computeroutput"><span class="identifier">checkout</span></code>
344                </p>
345              </td>
346<td>
347              </td>
348</tr>
349<tr>
350<td>
351                <p>
352                  <code class="computeroutput"><span class="identifier">merge</span></code>
353                </p>
354              </td>
355<td>
356              </td>
357</tr>
358<tr>
359<td>
360                <p>
361                  <code class="computeroutput"><span class="identifier">msearch</span></code>
362                </p>
363              </td>
364<td>
365              </td>
366</tr>
367<tr>
368<td>
369                <p>
370                  <code class="computeroutput"><span class="identifier">notify</span></code>
371                </p>
372              </td>
373<td>
374              </td>
375</tr>
376<tr>
377<td>
378                <p>
379                  <code class="computeroutput"><span class="identifier">subscribe</span></code>
380                </p>
381              </td>
382<td>
383              </td>
384</tr>
385<tr>
386<td>
387                <p>
388                  <code class="computeroutput"><span class="identifier">unsubscribe</span></code>
389                </p>
390              </td>
391<td>
392              </td>
393</tr>
394<tr>
395<td>
396                <p>
397                  <code class="computeroutput"><span class="identifier">patch</span></code>
398                </p>
399              </td>
400<td>
401              </td>
402</tr>
403<tr>
404<td>
405                <p>
406                  <code class="computeroutput"><span class="identifier">purge</span></code>
407                </p>
408              </td>
409<td>
410              </td>
411</tr>
412<tr>
413<td>
414                <p>
415                  <code class="computeroutput"><span class="identifier">mkcalendar</span></code>
416                </p>
417              </td>
418<td>
419              </td>
420</tr>
421<tr>
422<td>
423                <p>
424                  <code class="computeroutput"><span class="identifier">link</span></code>
425                </p>
426              </td>
427<td>
428              </td>
429</tr>
430<tr>
431<td>
432                <p>
433                  <code class="computeroutput"><span class="identifier">unlink</span></code>
434                </p>
435              </td>
436<td>
437              </td>
438</tr>
439</tbody>
440</table></div>
441<h5>
442<a name="beast.ref.boost__beast__http__verb.h2"></a>
443        <span class="phrase"><a name="beast.ref.boost__beast__http__verb.description"></a></span><a class="link" href="boost__beast__http__verb.html#beast.ref.boost__beast__http__verb.description">Description</a>
444      </h5>
445<p>
446        Each verb corresponds to a particular method string used in HTTP request
447        messages.
448      </p>
449</div>
450<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
451<td align="left"></td>
452<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
453      Falco<p>
454        Distributed under the Boost Software License, Version 1.0. (See accompanying
455        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>)
456      </p>
457</div></td>
458</tr></table>
459<hr>
460<div class="spirit-nav">
461<a accesskey="p" href="boost__beast__http__status_class.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__http__chunk_extensions.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
462</div>
463</body>
464</html>
465