libs/beast/doc/html/beast/ref/boost__beast__websocket__stream_base__timeout/keep_alive_pings.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::stream_base::timeout::keep_alive_pings</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="../boost__beast__websocket__stream_base__timeout.html" title="websocket::stream_base::timeout">
   9 <link rel="prev" href="idle_timeout.html" title="websocket::stream_base::timeout::idle_timeout">
  10 <link rel="next" href="suggested.html" title="websocket::stream_base::timeout::suggested">
  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="idle_timeout.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream_base__timeout.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="suggested.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings"></a><a class="link" href="keep_alive_pings.html" title="websocket::stream_base::timeout::keep_alive_pings">websocket::stream_base::timeout::keep_alive_pings</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873469249312"></a>
  31 Automatic ping setting.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.synopsis"></a></span><a class="link" href="keep_alive_pings.html#beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">keep_alive_pings</span><span class="special">;</span>
  38 </pre>
  39 <h6>
  40 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.h1"></a>
  41           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.description"></a></span><a class="link" href="keep_alive_pings.html#beast.ref.boost__beast__websocket__stream_base__timeout.keep_alive_pings.description">Description</a>
  42         </h6>
  43 <p>
  44           If the idle interval is set, this setting affects the behavior of the stream
  45           when no data is received for the timeout interval as follows:
  46         </p>
  47 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  48 <li class="listitem">
  49               When <code class="computeroutput"><span class="identifier">keep_alive_pings</span></code>
  50               is <code class="computeroutput"><span class="keyword">true</span></code>, an idle ping
  51               will be sent automatically. If another timeout interval elapses with
  52               no received data then the connection will be closed. An outstanding
  53               read operation must be pending, which will complete immediately the
  54               error <a class="link" href="../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">timeout</span></code></a>.
  55             </li>
  56 <li class="listitem">
  57               When <code class="computeroutput"><span class="identifier">keep_alive_pings</span></code>
  58               is <code class="computeroutput"><span class="keyword">false</span></code>, the connection
  59               will be closed. An outstanding read operation must be pending, which
  60               will complete immediately the error <a class="link" href="../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">timeout</span></code></a>.
  61             </li>
  62 </ul></div>
  63 </div>
  64 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  65 <td align="left"></td>
  66 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  67       Falco<p>
  68         Distributed under the Boost Software License, Version 1.0. (See accompanying
  69         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>)
  70       </p>
  71 </div></td>
  72 </tr></table>
  73 <hr>
  74 <div class="spirit-nav">
  75 <a accesskey="p" href="idle_timeout.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream_base__timeout.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="suggested.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  76 </div>
  77 </body>
  78 </html>