1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>generic::stream_protocol::iostream</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="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../generic__stream_protocol.html" title="generic::stream_protocol"> 9<link rel="prev" href="family.html" title="generic::stream_protocol::family"> 10<link rel="next" href="operator_not__eq_.html" title="generic::stream_protocol::operator!="> 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="family.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__stream_protocol.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator_not__eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="boost_asio.reference.generic__stream_protocol.iostream"></a><a class="link" href="iostream.html" title="generic::stream_protocol::iostream">generic::stream_protocol::iostream</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.generic__stream_protocol.iostream"></a> 31The 32 generic socket iostream type. 33 </p> 34<pre class="programlisting">typedef basic_socket_iostream< stream_protocol > iostream; 35</pre> 36<h6> 37<a name="boost_asio.reference.generic__stream_protocol.iostream.h0"></a> 38 <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.iostream.types"></a></span><a class="link" href="iostream.html#boost_asio.reference.generic__stream_protocol.iostream.types">Types</a> 39 </h6> 40<div class="informaltable"><table class="table"> 41<colgroup> 42<col> 43<col> 44</colgroup> 45<thead><tr> 46<th> 47 <p> 48 Name 49 </p> 50 </th> 51<th> 52 <p> 53 Description 54 </p> 55 </th> 56</tr></thead> 57<tbody> 58<tr> 59<td> 60 <p> 61 <a class="link" href="../basic_socket_iostream/clock_type.html" title="basic_socket_iostream::clock_type"><span class="bold"><strong>clock_type</strong></span></a> 62 </p> 63 </td> 64<td> 65 <p> 66 The clock type. 67 </p> 68 </td> 69</tr> 70<tr> 71<td> 72 <p> 73 <a class="link" href="../basic_socket_iostream/duration.html" title="basic_socket_iostream::duration"><span class="bold"><strong>duration</strong></span></a> 74 </p> 75 </td> 76<td> 77 <p> 78 The duration type. 79 </p> 80 </td> 81</tr> 82<tr> 83<td> 84 <p> 85 <a class="link" href="../basic_socket_iostream/duration_type.html" title="basic_socket_iostream::duration_type"><span class="bold"><strong>duration_type</strong></span></a> 86 </p> 87 </td> 88<td> 89 <p> 90 (Deprecated: Use duration.) The duration type. 91 </p> 92 </td> 93</tr> 94<tr> 95<td> 96 <p> 97 <a class="link" href="../basic_socket_iostream/endpoint_type.html" title="basic_socket_iostream::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a> 98 </p> 99 </td> 100<td> 101 <p> 102 The endpoint type. 103 </p> 104 </td> 105</tr> 106<tr> 107<td> 108 <p> 109 <a class="link" href="../basic_socket_iostream/protocol_type.html" title="basic_socket_iostream::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> 110 </p> 111 </td> 112<td> 113 <p> 114 The protocol type. 115 </p> 116 </td> 117</tr> 118<tr> 119<td> 120 <p> 121 <a class="link" href="../basic_socket_iostream/time_point.html" title="basic_socket_iostream::time_point"><span class="bold"><strong>time_point</strong></span></a> 122 </p> 123 </td> 124<td> 125 <p> 126 The time type. 127 </p> 128 </td> 129</tr> 130<tr> 131<td> 132 <p> 133 <a class="link" href="../basic_socket_iostream/time_type.html" title="basic_socket_iostream::time_type"><span class="bold"><strong>time_type</strong></span></a> 134 </p> 135 </td> 136<td> 137 <p> 138 (Deprecated: Use time_point.) The time type. 139 </p> 140 </td> 141</tr> 142</tbody> 143</table></div> 144<h6> 145<a name="boost_asio.reference.generic__stream_protocol.iostream.h1"></a> 146 <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.iostream.member_functions"></a></span><a class="link" href="iostream.html#boost_asio.reference.generic__stream_protocol.iostream.member_functions">Member 147 Functions</a> 148 </h6> 149<div class="informaltable"><table class="table"> 150<colgroup> 151<col> 152<col> 153</colgroup> 154<thead><tr> 155<th> 156 <p> 157 Name 158 </p> 159 </th> 160<th> 161 <p> 162 Description 163 </p> 164 </th> 165</tr></thead> 166<tbody> 167<tr> 168<td> 169 <p> 170 <a class="link" href="../basic_socket_iostream/basic_socket_iostream.html" title="basic_socket_iostream::basic_socket_iostream"><span class="bold"><strong>basic_socket_iostream</strong></span></a> <span class="silver">[constructor]</span> 171 </p> 172 </td> 173<td> 174 <p> 175 Construct a basic_socket_iostream without establishing a connection. 176 <br> <span class="silver"> —</span><br> Construct a basic_socket_iostream from the supplied 177 socket. <br> <span class="silver"> —</span><br> Move-construct a basic_socket_iostream 178 from another. <br> <span class="silver"> —</span><br> Establish a connection to an endpoint 179 corresponding to a resolver query. 180 </p> 181 </td> 182</tr> 183<tr> 184<td> 185 <p> 186 <a class="link" href="../basic_socket_iostream/close.html" title="basic_socket_iostream::close"><span class="bold"><strong>close</strong></span></a> 187 </p> 188 </td> 189<td> 190 <p> 191 Close the connection. 192 </p> 193 </td> 194</tr> 195<tr> 196<td> 197 <p> 198 <a class="link" href="../basic_socket_iostream/connect.html" title="basic_socket_iostream::connect"><span class="bold"><strong>connect</strong></span></a> 199 </p> 200 </td> 201<td> 202 <p> 203 Establish a connection to an endpoint corresponding to a resolver 204 query. 205 </p> 206 </td> 207</tr> 208<tr> 209<td> 210 <p> 211 <a class="link" href="../basic_socket_iostream/error.html" title="basic_socket_iostream::error"><span class="bold"><strong>error</strong></span></a> 212 </p> 213 </td> 214<td> 215 <p> 216 Get the last error associated with the stream. 217 </p> 218 </td> 219</tr> 220<tr> 221<td> 222 <p> 223 <a class="link" href="../basic_socket_iostream/expires_after.html" title="basic_socket_iostream::expires_after"><span class="bold"><strong>expires_after</strong></span></a> 224 </p> 225 </td> 226<td> 227 <p> 228 Set the stream's expiry time relative to now. 229 </p> 230 </td> 231</tr> 232<tr> 233<td> 234 <p> 235 <a class="link" href="../basic_socket_iostream/expires_at.html" title="basic_socket_iostream::expires_at"><span class="bold"><strong>expires_at</strong></span></a> 236 </p> 237 </td> 238<td> 239 <p> 240 (Deprecated: Use expiry().) Get the stream's expiry time as an 241 absolute time. <br> <span class="silver"> —</span><br> Set the stream's expiry time as 242 an absolute time. 243 </p> 244 </td> 245</tr> 246<tr> 247<td> 248 <p> 249 <a class="link" href="../basic_socket_iostream/expires_from_now.html" title="basic_socket_iostream::expires_from_now"><span class="bold"><strong>expires_from_now</strong></span></a> 250 </p> 251 </td> 252<td> 253 <p> 254 (Deprecated: Use expiry().) Get the stream's expiry time relative 255 to now. <br> <span class="silver"> —</span><br> (Deprecated: Use expires_after().) Set 256 the stream's expiry time relative to now. 257 </p> 258 </td> 259</tr> 260<tr> 261<td> 262 <p> 263 <a class="link" href="../basic_socket_iostream/expiry.html" title="basic_socket_iostream::expiry"><span class="bold"><strong>expiry</strong></span></a> 264 </p> 265 </td> 266<td> 267 <p> 268 Get the stream's expiry time as an absolute time. 269 </p> 270 </td> 271</tr> 272<tr> 273<td> 274 <p> 275 <a class="link" href="../basic_socket_iostream/operator_eq_.html" title="basic_socket_iostream::operator="><span class="bold"><strong>operator=</strong></span></a> 276 </p> 277 </td> 278<td> 279 <p> 280 Move-assign a basic_socket_iostream from another. 281 </p> 282 </td> 283</tr> 284<tr> 285<td> 286 <p> 287 <a class="link" href="../basic_socket_iostream/rdbuf.html" title="basic_socket_iostream::rdbuf"><span class="bold"><strong>rdbuf</strong></span></a> 288 </p> 289 </td> 290<td> 291 <p> 292 Return a pointer to the underlying streambuf. 293 </p> 294 </td> 295</tr> 296<tr> 297<td> 298 <p> 299 <a class="link" href="../basic_socket_iostream/socket.html" title="basic_socket_iostream::socket"><span class="bold"><strong>socket</strong></span></a> 300 </p> 301 </td> 302<td> 303 <p> 304 Get a reference to the underlying socket. 305 </p> 306 </td> 307</tr> 308</tbody> 309</table></div> 310<h6> 311<a name="boost_asio.reference.generic__stream_protocol.iostream.h2"></a> 312 <span class="phrase"><a name="boost_asio.reference.generic__stream_protocol.iostream.requirements"></a></span><a class="link" href="iostream.html#boost_asio.reference.generic__stream_protocol.iostream.requirements">Requirements</a> 313 </h6> 314<p> 315 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/generic/stream_protocol.hpp</code> 316 </p> 317<p> 318 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 319 </p> 320</div> 321<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 322<td align="left"></td> 323<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 324 Kohlhoff<p> 325 Distributed under the Boost Software License, Version 1.0. (See accompanying 326 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>) 327 </p> 328</div></td> 329</tr></table> 330<hr> 331<div class="spirit-nav"> 332<a accesskey="p" href="family.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../generic__stream_protocol.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator_not__eq_.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 333</div> 334</body> 335</html> 336
