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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::stream_base::timeout::suggested</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="keep_alive_pings.html" title="websocket::stream_base::timeout::keep_alive_pings">
  10 <link rel="next" href="../boost__beast__websocket__teardown.html" title="websocket::teardown">
  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="keep_alive_pings.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="../boost__beast__websocket__teardown.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.suggested"></a><a class="link" href="suggested.html" title="websocket::stream_base::timeout::suggested">websocket::stream_base::timeout::suggested</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873469225664"></a>
  31 Construct timeout settings with
  32           suggested values for a role.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.synopsis"></a></span><a class="link" href="suggested.html#beast.ref.boost__beast__websocket__stream_base__timeout.suggested.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="keyword">static</span>
  39 <span class="identifier">timeout</span>
  40 <span class="identifier">suggested</span><span class="special">(</span>
  41     <span class="identifier">role_type</span> <span class="identifier">role</span><span class="special">);</span>
  42 </pre>
  43 <h6>
  44 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.h1"></a>
  45           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.description"></a></span><a class="link" href="suggested.html#beast.ref.boost__beast__websocket__stream_base__timeout.suggested.description">Description</a>
  46         </h6>
  47 <p>
  48           This constructs the timeout settings with a predefined set of values which
  49           varies depending on the desired role. The values are selected upon construction,
  50           regardless of the current or actual role in use on the stream.
  51         </p>
  52 <h6>
  53 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.h2"></a>
  54           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.example"></a></span><a class="link" href="suggested.html#beast.ref.boost__beast__websocket__stream_base__timeout.suggested.example">Example</a>
  55         </h6>
  56 <p>
  57           This statement sets the timeout settings of the stream to the suggested
  58           values for the server role:
  59         </p>
  60 <h6>
  61 <a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.h3"></a>
  62           <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream_base__timeout.suggested.parameters"></a></span><a class="link" href="suggested.html#beast.ref.boost__beast__websocket__stream_base__timeout.suggested.parameters">Parameters</a>
  63         </h6>
  64 <div class="informaltable"><table class="table">
  65 <colgroup>
  66 <col>
  67 <col>
  68 </colgroup>
  69 <thead><tr>
  70 <th>
  71                   <p>
  72                     Name
  73                   </p>
  74                 </th>
  75 <th>
  76                   <p>
  77                     Description
  78                   </p>
  79                 </th>
  80 </tr></thead>
  81 <tbody><tr>
  82 <td>
  83                   <p>
  84                     <code class="computeroutput"><span class="identifier">role</span></code>
  85                   </p>
  86                 </td>
  87 <td>
  88                   <p>
  89                     The role of the websocket stream (<a class="link" href="../boost__beast__role_type.html" title="role_type"><code class="computeroutput"><span class="identifier">client</span></code></a> or <a class="link" href="../boost__beast__role_type.html" title="role_type"><code class="computeroutput"><span class="identifier">server</span></code></a>).
  90                   </p>
  91                 </td>
  92 </tr></tbody>
  93 </table></div>
  94 </div>
  95 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  96 <td align="left"></td>
  97 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  98       Falco<p>
  99         Distributed under the Boost Software License, Version 1.0. (See accompanying
 100         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>)
 101       </p>
 102 </div></td>
 103 </tr></table>
 104 <hr>
 105 <div class="spirit-nav">
 106 <a accesskey="p" href="keep_alive_pings.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="../boost__beast__websocket__teardown.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 107 </div>
 108 </body>
 109 </html>