libs/beast/doc/html/beast/ref/boost__beast__basic_stream/expires_after.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream::expires_after</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__basic_stream.html" title="basic_stream">
   9 <link rel="prev" href="executor_type.html" title="basic_stream::executor_type">
  10 <link rel="next" href="expires_at.html" title="basic_stream::expires_at">
  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="executor_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_stream.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="expires_at.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__basic_stream.expires_after"></a><a class="link" href="expires_after.html" title="basic_stream::expires_after">basic_stream::expires_after</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873515363088"></a>
  31 Set the timeout for the next logical operation.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__basic_stream.expires_after.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.expires_after.synopsis"></a></span><a class="link" href="expires_after.html#beast.ref.boost__beast__basic_stream.expires_after.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">expires_after</span><span class="special">(</span>
  39     <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">nanoseconds</span> <span class="identifier">expiry_time</span><span class="special">);</span>
  40 </pre>
  41 <h6>
  42 <a name="beast.ref.boost__beast__basic_stream.expires_after.h1"></a>
  43           <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.expires_after.description"></a></span><a class="link" href="expires_after.html#beast.ref.boost__beast__basic_stream.expires_after.description">Description</a>
  44         </h6>
  45 <p>
  46           This sets either the read timer, the write timer, or both timers to expire
  47           after the specified amount of time has elapsed. If a timer expires when
  48           the corresponding asynchronous operation is outstanding, the stream will
  49           be closed and any outstanding operations will complete with the error
  50           <a class="link" href="../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">timeout</span></code></a>.
  51           Otherwise, if the timer expires while no operations are outstanding, and
  52           the expiraton is not set again, the next operation will time out immediately.
  53           The timer applies collectively to any asynchronous reads or writes initiated
  54           after the expiration is set, until the expiration is set again. A call
  55           to <a class="link" href="async_connect.html" title="basic_stream::async_connect"><code class="computeroutput"><span class="identifier">basic_stream</span><span class="special">::</span><span class="identifier">async_connect</span></code></a> counts as both a
  56           read and a write.
  57         </p>
  58 <h6>
  59 <a name="beast.ref.boost__beast__basic_stream.expires_after.h2"></a>
  60           <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.expires_after.parameters"></a></span><a class="link" href="expires_after.html#beast.ref.boost__beast__basic_stream.expires_after.parameters">Parameters</a>
  61         </h6>
  62 <div class="informaltable"><table class="table">
  63 <colgroup>
  64 <col>
  65 <col>
  66 </colgroup>
  67 <thead><tr>
  68 <th>
  69                   <p>
  70                     Name
  71                   </p>
  72                 </th>
  73 <th>
  74                   <p>
  75                     Description
  76                   </p>
  77                 </th>
  78 </tr></thead>
  79 <tbody><tr>
  80 <td>
  81                   <p>
  82                     <code class="computeroutput"><span class="identifier">expiry_time</span></code>
  83                   </p>
  84                 </td>
  85 <td>
  86                   <p>
  87                     The amount of time after which a logical operation should be
  88                     considered timed out.
  89                   </p>
  90                 </td>
  91 </tr></tbody>
  92 </table></div>
  93 </div>
  94 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  95 <td align="left"></td>
  96 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  97       Falco<p>
  98         Distributed under the Boost Software License, Version 1.0. (See accompanying
  99         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>)
 100       </p>
 101 </div></td>
 102 </tr></table>
 103 <hr>
 104 <div class="spirit-nav">
 105 <a accesskey="p" href="executor_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_stream.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="expires_at.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 106 </div>
 107 </body>
 108 </html>