doc/html/boost_asio/reference/basic_socket_iostream.html

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