libs/beast/doc/html/beast/ref/boost__beast__websocket__frame_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::frame_type</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__websocket__error.html" title="websocket::error">
  10 <link rel="next" href="boost__beast__websocket__is_upgrade.html" title="websocket::is_upgrade">
  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__websocket__error.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__websocket__is_upgrade.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__websocket__frame_type"></a><a class="link" href="boost__beast__websocket__frame_type.html" title="websocket::frame_type">websocket::frame_type</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873475120768"></a>
  31 The type of received control frame.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__websocket__frame_type.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__websocket__frame_type.synopsis"></a></span><a class="link" href="boost__beast__websocket__frame_type.html#beast.ref.boost__beast__websocket__frame_type.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket/stream.hpp" target="_top">boost/beast/websocket/stream.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">frame_type</span>
  41 </pre>
  42 <p>
  43         <a class="indexterm" name="idm45873475112800"></a>
  44  <a class="indexterm" name="idm45873475111696"></a>
  45  <a class="indexterm" name="idm45873475110592"></a>
  46
  47       </p>
  48 <h5>
  49 <a name="beast.ref.boost__beast__websocket__frame_type.h1"></a>
  50         <span class="phrase"><a name="beast.ref.boost__beast__websocket__frame_type.values"></a></span><a class="link" href="boost__beast__websocket__frame_type.html#beast.ref.boost__beast__websocket__frame_type.values">Values</a>
  51       </h5>
  52 <div class="informaltable"><table class="table">
  53 <colgroup>
  54 <col>
  55 <col>
  56 </colgroup>
  57 <thead><tr>
  58 <th>
  59                 <p>
  60                   Name
  61                 </p>
  62               </th>
  63 <th>
  64                 <p>
  65                   Description
  66                 </p>
  67               </th>
  68 </tr></thead>
  69 <tbody>
  70 <tr>
  71 <td>
  72                 <p>
  73                   <code class="literal">close</code>
  74                 </p>
  75               </td>
  76 <td>
  77                 <p>
  78                   A close frame was received.
  79                 </p>
  80               </td>
  81 </tr>
  82 <tr>
  83 <td>
  84                 <p>
  85                   <code class="literal">ping</code>
  86                 </p>
  87               </td>
  88 <td>
  89                 <p>
  90                   A ping frame was received.
  91                 </p>
  92               </td>
  93 </tr>
  94 <tr>
  95 <td>
  96                 <p>
  97                   <code class="literal">pong</code>
  98                 </p>
  99               </td>
 100 <td>
 101                 <p>
 102                   A pong frame was received.
 103                 </p>
 104               </td>
 105 </tr>
 106 </tbody>
 107 </table></div>
 108 <h5>
 109 <a name="beast.ref.boost__beast__websocket__frame_type.h2"></a>
 110         <span class="phrase"><a name="beast.ref.boost__beast__websocket__frame_type.description"></a></span><a class="link" href="boost__beast__websocket__frame_type.html#beast.ref.boost__beast__websocket__frame_type.description">Description</a>
 111       </h5>
 112 <p>
 113         Values of this type are passed to the control frame callback set using <a class="link" href="boost__beast__websocket__stream/control_callback.html" title="websocket::stream::control_callback"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">control_callback</span></code></a>.
 114       </p>
 115 <p>
 116         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>&gt;</code>
 117       </p>
 118 </div>
 119 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 120 <td align="left"></td>
 121 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 122       Falco<p>
 123         Distributed under the Boost Software License, Version 1.0. (See accompanying
 124         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>)
 125       </p>
 126 </div></td>
 127 </tr></table>
 128 <hr>
 129 <div class="spirit-nav">
 130 <a accesskey="p" href="boost__beast__websocket__error.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__websocket__is_upgrade.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 131 </div>
 132 </body>
 133 </html>