1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 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 1. 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="idm46057545909712"></a> 31 </p> 32<p> 33 Set the timeout for the next logical operation. 34 </p> 35<h6> 36<a name="beast.ref.boost__beast__basic_stream.expires_at.h0"></a> 37 <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> 38 </h6> 39<pre class="programlisting"><span class="keyword">void</span> 40<span class="identifier">expires_at</span><span class="special">(</span> 41 <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> 42</pre> 43<h6> 44<a name="beast.ref.boost__beast__basic_stream.expires_at.h1"></a> 45 <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> 46 </h6> 47<p> 48 This sets either the read timer, the write timer, or both timers to expire 49 at the specified time point. If a timer expires when the corresponding 50 asynchronous operation is outstanding, the stream will be closed and any 51 outstanding operations will complete with the error <a class="link" href="../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">timeout</span></code></a>. Otherwise, if the timer 52 expires while no operations are outstanding, and the expiraton is not set 53 again, the next operation will time out immediately. The timer applies 54 collectively to any asynchronous reads or writes initiated after the expiration 55 is set, until the expiration is set again. A call to <a class="link" href="async_connect/overload1.html" title="basic_stream::async_connect (1 of 5 overloads)"><code class="computeroutput"><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_at.h2"></a> 60 <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> 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 time point after which a logical operation should be considered 88 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 © 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="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> 106</div> 107</body> 108</html> 109
