1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_socket_streambuf</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="../reference.html" title="Reference"> 9<link rel="prev" href="basic_socket_iostream/time_type.html" title="basic_socket_iostream::time_type"> 10<link rel="next" href="basic_socket_streambuf/basic_socket_streambuf.html" title="basic_socket_streambuf::basic_socket_streambuf"> 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="basic_socket_iostream/time_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="basic_socket_streambuf/basic_socket_streambuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.basic_socket_streambuf"></a><a class="link" href="basic_socket_streambuf.html" title="basic_socket_streambuf">basic_socket_streambuf</a> 28</h3></div></div></div> 29<p> 30 Iostream streambuf for a socket. 31 </p> 32<pre class="programlisting">template< 33 typename <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a>, 34 typename Clock = chrono::steady_clock, 35 typename <a class="link" href="WaitTraits.html" title="Wait traits requirements">WaitTraits</a> = wait_traits<Clock>> 36class basic_socket_streambuf : 37 basic_socket< Protocol > 38</pre> 39<h5> 40<a name="boost_asio.reference.basic_socket_streambuf.h0"></a> 41 <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.types"></a></span><a class="link" href="basic_socket_streambuf.html#boost_asio.reference.basic_socket_streambuf.types">Types</a> 42 </h5> 43<div class="informaltable"><table class="table"> 44<colgroup> 45<col> 46<col> 47</colgroup> 48<thead><tr> 49<th> 50 <p> 51 Name 52 </p> 53 </th> 54<th> 55 <p> 56 Description 57 </p> 58 </th> 59</tr></thead> 60<tbody> 61<tr> 62<td> 63 <p> 64 <a class="link" href="basic_socket_streambuf/clock_type.html" title="basic_socket_streambuf::clock_type"><span class="bold"><strong>clock_type</strong></span></a> 65 </p> 66 </td> 67<td> 68 <p> 69 The clock type. 70 </p> 71 </td> 72</tr> 73<tr> 74<td> 75 <p> 76 <a class="link" href="basic_socket_streambuf/duration.html" title="basic_socket_streambuf::duration"><span class="bold"><strong>duration</strong></span></a> 77 </p> 78 </td> 79<td> 80 <p> 81 The duration type. 82 </p> 83 </td> 84</tr> 85<tr> 86<td> 87 <p> 88 <a class="link" href="basic_socket_streambuf/duration_type.html" title="basic_socket_streambuf::duration_type"><span class="bold"><strong>duration_type</strong></span></a> 89 </p> 90 </td> 91<td> 92 <p> 93 (Deprecated: Use duration.) The duration type. 94 </p> 95 </td> 96</tr> 97<tr> 98<td> 99 <p> 100 <a class="link" href="basic_socket_streambuf/endpoint_type.html" title="basic_socket_streambuf::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a> 101 </p> 102 </td> 103<td> 104 <p> 105 The endpoint type. 106 </p> 107 </td> 108</tr> 109<tr> 110<td> 111 <p> 112 <a class="link" href="basic_socket_streambuf/protocol_type.html" title="basic_socket_streambuf::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> 113 </p> 114 </td> 115<td> 116 <p> 117 The protocol type. 118 </p> 119 </td> 120</tr> 121<tr> 122<td> 123 <p> 124 <a class="link" href="basic_socket_streambuf/time_point.html" title="basic_socket_streambuf::time_point"><span class="bold"><strong>time_point</strong></span></a> 125 </p> 126 </td> 127<td> 128 <p> 129 The time type. 130 </p> 131 </td> 132</tr> 133<tr> 134<td> 135 <p> 136 <a class="link" href="basic_socket_streambuf/time_type.html" title="basic_socket_streambuf::time_type"><span class="bold"><strong>time_type</strong></span></a> 137 </p> 138 </td> 139<td> 140 <p> 141 (Deprecated: Use time_point.) The time type. 142 </p> 143 </td> 144</tr> 145</tbody> 146</table></div> 147<h5> 148<a name="boost_asio.reference.basic_socket_streambuf.h1"></a> 149 <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.member_functions"></a></span><a class="link" href="basic_socket_streambuf.html#boost_asio.reference.basic_socket_streambuf.member_functions">Member 150 Functions</a> 151 </h5> 152<div class="informaltable"><table class="table"> 153<colgroup> 154<col> 155<col> 156</colgroup> 157<thead><tr> 158<th> 159 <p> 160 Name 161 </p> 162 </th> 163<th> 164 <p> 165 Description 166 </p> 167 </th> 168</tr></thead> 169<tbody> 170<tr> 171<td> 172 <p> 173 <a class="link" href="basic_socket_streambuf/basic_socket_streambuf.html" title="basic_socket_streambuf::basic_socket_streambuf"><span class="bold"><strong>basic_socket_streambuf</strong></span></a> <span class="silver">[constructor]</span> 174 </p> 175 </td> 176<td> 177 <p> 178 Construct a basic_socket_streambuf without establishing a connection. 179 <br> <span class="silver"> —</span><br> Construct a basic_socket_streambuf from the supplied 180 socket. <br> <span class="silver"> —</span><br> Move-construct a basic_socket_streambuf from 181 another. 182 </p> 183 </td> 184</tr> 185<tr> 186<td> 187 <p> 188 <a class="link" href="basic_socket_streambuf/close.html" title="basic_socket_streambuf::close"><span class="bold"><strong>close</strong></span></a> 189 </p> 190 </td> 191<td> 192 <p> 193 Close the connection. 194 </p> 195 </td> 196</tr> 197<tr> 198<td> 199 <p> 200 <a class="link" href="basic_socket_streambuf/connect.html" title="basic_socket_streambuf::connect"><span class="bold"><strong>connect</strong></span></a> 201 </p> 202 </td> 203<td> 204 <p> 205 Establish a connection. 206 </p> 207 </td> 208</tr> 209<tr> 210<td> 211 <p> 212 <a class="link" href="basic_socket_streambuf/error.html" title="basic_socket_streambuf::error"><span class="bold"><strong>error</strong></span></a> 213 </p> 214 </td> 215<td> 216 <p> 217 Get the last error associated with the stream buffer. 218 </p> 219 </td> 220</tr> 221<tr> 222<td> 223 <p> 224 <a class="link" href="basic_socket_streambuf/expires_after.html" title="basic_socket_streambuf::expires_after"><span class="bold"><strong>expires_after</strong></span></a> 225 </p> 226 </td> 227<td> 228 <p> 229 Set the stream buffer's expiry time relative to now. 230 </p> 231 </td> 232</tr> 233<tr> 234<td> 235 <p> 236 <a class="link" href="basic_socket_streambuf/expires_at.html" title="basic_socket_streambuf::expires_at"><span class="bold"><strong>expires_at</strong></span></a> 237 </p> 238 </td> 239<td> 240 <p> 241 (Deprecated: Use expiry().) Get the stream buffer's expiry time 242 as an absolute time. <br> <span class="silver"> —</span><br> Set the stream buffer's expiry 243 time as an absolute time. 244 </p> 245 </td> 246</tr> 247<tr> 248<td> 249 <p> 250 <a class="link" href="basic_socket_streambuf/expires_from_now.html" title="basic_socket_streambuf::expires_from_now"><span class="bold"><strong>expires_from_now</strong></span></a> 251 </p> 252 </td> 253<td> 254 <p> 255 (Deprecated: Use expiry().) Get the stream buffer's expiry time 256 relative to now. <br> <span class="silver"> —</span><br> (Deprecated: Use expires_after().) 257 Set the stream buffer's expiry time relative to now. 258 </p> 259 </td> 260</tr> 261<tr> 262<td> 263 <p> 264 <a class="link" href="basic_socket_streambuf/expiry.html" title="basic_socket_streambuf::expiry"><span class="bold"><strong>expiry</strong></span></a> 265 </p> 266 </td> 267<td> 268 <p> 269 Get the stream buffer's expiry time as an absolute time. 270 </p> 271 </td> 272</tr> 273<tr> 274<td> 275 <p> 276 <a class="link" href="basic_socket_streambuf/operator_eq_.html" title="basic_socket_streambuf::operator="><span class="bold"><strong>operator=</strong></span></a> 277 </p> 278 </td> 279<td> 280 <p> 281 Move-assign a basic_socket_streambuf from another. 282 </p> 283 </td> 284</tr> 285<tr> 286<td> 287 <p> 288 <a class="link" href="basic_socket_streambuf/puberror.html" title="basic_socket_streambuf::puberror"><span class="bold"><strong>puberror</strong></span></a> 289 </p> 290 </td> 291<td> 292 <p> 293 (Deprecated: Use error().) Get the last error associated with the 294 stream buffer. 295 </p> 296 </td> 297</tr> 298<tr> 299<td> 300 <p> 301 <a class="link" href="basic_socket_streambuf/socket.html" title="basic_socket_streambuf::socket"><span class="bold"><strong>socket</strong></span></a> 302 </p> 303 </td> 304<td> 305 <p> 306 Get a reference to the underlying socket. 307 </p> 308 </td> 309</tr> 310<tr> 311<td> 312 <p> 313 <a class="link" href="basic_socket_streambuf/_basic_socket_streambuf.html" title="basic_socket_streambuf::~basic_socket_streambuf"><span class="bold"><strong>~basic_socket_streambuf</strong></span></a> <span class="silver">[destructor]</span> 314 </p> 315 </td> 316<td> 317 <p> 318 Destructor flushes buffered data. 319 </p> 320 </td> 321</tr> 322</tbody> 323</table></div> 324<h5> 325<a name="boost_asio.reference.basic_socket_streambuf.h2"></a> 326 <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.protected_member_functions"></a></span><a class="link" href="basic_socket_streambuf.html#boost_asio.reference.basic_socket_streambuf.protected_member_functions">Protected 327 Member Functions</a> 328 </h5> 329<div class="informaltable"><table class="table"> 330<colgroup> 331<col> 332<col> 333</colgroup> 334<thead><tr> 335<th> 336 <p> 337 Name 338 </p> 339 </th> 340<th> 341 <p> 342 Description 343 </p> 344 </th> 345</tr></thead> 346<tbody> 347<tr> 348<td> 349 <p> 350 <a class="link" href="basic_socket_streambuf/overflow.html" title="basic_socket_streambuf::overflow"><span class="bold"><strong>overflow</strong></span></a> 351 </p> 352 </td> 353<td> 354 </td> 355</tr> 356<tr> 357<td> 358 <p> 359 <a class="link" href="basic_socket_streambuf/setbuf.html" title="basic_socket_streambuf::setbuf"><span class="bold"><strong>setbuf</strong></span></a> 360 </p> 361 </td> 362<td> 363 </td> 364</tr> 365<tr> 366<td> 367 <p> 368 <a class="link" href="basic_socket_streambuf/sync.html" title="basic_socket_streambuf::sync"><span class="bold"><strong>sync</strong></span></a> 369 </p> 370 </td> 371<td> 372 </td> 373</tr> 374<tr> 375<td> 376 <p> 377 <a class="link" href="basic_socket_streambuf/underflow.html" title="basic_socket_streambuf::underflow"><span class="bold"><strong>underflow</strong></span></a> 378 </p> 379 </td> 380<td> 381 </td> 382</tr> 383</tbody> 384</table></div> 385<h5> 386<a name="boost_asio.reference.basic_socket_streambuf.h3"></a> 387 <span class="phrase"><a name="boost_asio.reference.basic_socket_streambuf.requirements"></a></span><a class="link" href="basic_socket_streambuf.html#boost_asio.reference.basic_socket_streambuf.requirements">Requirements</a> 388 </h5> 389<p> 390 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_socket_streambuf.hpp</code> 391 </p> 392<p> 393 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 394 </p> 395</div> 396<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 397<td align="left"></td> 398<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 399 Kohlhoff<p> 400 Distributed under the Boost Software License, Version 1.0. (See accompanying 401 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>) 402 </p> 403</div></td> 404</tr></table> 405<hr> 406<div class="spirit-nav"> 407<a accesskey="p" href="basic_socket_iostream/time_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="basic_socket_streambuf/basic_socket_streambuf.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 408</div> 409</body> 410</html> 411
