libs/beast/doc/html/beast/ref/boost__beast__http__verb.html

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