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

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