doc/html/boost_asio/reference/local__stream_protocol/iostream.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>local::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="../local__stream_protocol.html" title="local::stream_protocol">
   9 <link rel="prev" href="family.html" title="local::stream_protocol::family">
  10 <link rel="next" href="protocol.html" title="local::stream_protocol::protocol">
  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="../local__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="protocol.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.local__stream_protocol.iostream"></a><a class="link" href="iostream.html" title="local::stream_protocol::iostream">local::stream_protocol::iostream</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp155298576"></a>
  31 The UNIX domain iostream type.
  32         </p>
  33 <pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">basic_socket_iostream</span><span class="special">&lt;</span> <span class="identifier">stream_protocol</span> <span class="special">&gt;</span> <span class="identifier">iostream</span><span class="special">;</span>
  34 </pre>
  35 <h6>
  36 <a name="boost_asio.reference.local__stream_protocol.iostream.h0"></a>
  37           <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.iostream.types"></a></span><a class="link" href="iostream.html#boost_asio.reference.local__stream_protocol.iostream.types">Types</a>
  38         </h6>
  39 <div class="informaltable"><table class="table">
  40 <colgroup>
  41 <col>
  42 <col>
  43 </colgroup>
  44 <thead><tr>
  45 <th>
  46                   <p>
  47                     Name
  48                   </p>
  49                 </th>
  50 <th>
  51                   <p>
  52                     Description
  53                   </p>
  54                 </th>
  55 </tr></thead>
  56 <tbody>
  57 <tr>
  58 <td>
  59                   <p>
  60                     <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>
  61                   </p>
  62                 </td>
  63 <td>
  64                   <p>
  65                     The duration type.
  66                   </p>
  67                 </td>
  68 </tr>
  69 <tr>
  70 <td>
  71                   <p>
  72                     <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>
  73                   </p>
  74                 </td>
  75 <td>
  76                   <p>
  77                     The endpoint type.
  78                   </p>
  79                 </td>
  80 </tr>
  81 <tr>
  82 <td>
  83                   <p>
  84                     <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>
  85                   </p>
  86                 </td>
  87 <td>
  88                   <p>
  89                     The time type.
  90                   </p>
  91                 </td>
  92 </tr>
  93 </tbody>
  94 </table></div>
  95 <h6>
  96 <a name="boost_asio.reference.local__stream_protocol.iostream.h1"></a>
  97           <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.iostream.member_functions"></a></span><a class="link" href="iostream.html#boost_asio.reference.local__stream_protocol.iostream.member_functions">Member
  98           Functions</a>
  99         </h6>
 100 <div class="informaltable"><table class="table">
 101 <colgroup>
 102 <col>
 103 <col>
 104 </colgroup>
 105 <thead><tr>
 106 <th>
 107                   <p>
 108                     Name
 109                   </p>
 110                 </th>
 111 <th>
 112                   <p>
 113                     Description
 114                   </p>
 115                 </th>
 116 </tr></thead>
 117 <tbody>
 118 <tr>
 119 <td>
 120                   <p>
 121                     <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>
 122                   </p>
 123                 </td>
 124 <td>
 125                   <p>
 126                     Construct a basic_socket_iostream without establishing a connection.
 127                   </p>
 128                   <p>
 129                     Establish a connection to an endpoint corresponding to a resolver
 130                     query.
 131                   </p>
 132                 </td>
 133 </tr>
 134 <tr>
 135 <td>
 136                   <p>
 137                     <a class="link" href="../basic_socket_iostream/close.html" title="basic_socket_iostream::close"><span class="bold"><strong>close</strong></span></a>
 138                   </p>
 139                 </td>
 140 <td>
 141                   <p>
 142                     Close the connection.
 143                   </p>
 144                 </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                   <p>
 149                     <a class="link" href="../basic_socket_iostream/connect.html" title="basic_socket_iostream::connect"><span class="bold"><strong>connect</strong></span></a>
 150                   </p>
 151                 </td>
 152 <td>
 153                   <p>
 154                     Establish a connection to an endpoint corresponding to a resolver
 155                     query.
 156                   </p>
 157                 </td>
 158 </tr>
 159 <tr>
 160 <td>
 161                   <p>
 162                     <a class="link" href="../basic_socket_iostream/error.html" title="basic_socket_iostream::error"><span class="bold"><strong>error</strong></span></a>
 163                   </p>
 164                 </td>
 165 <td>
 166                   <p>
 167                     Get the last error associated with the stream.
 168                   </p>
 169                 </td>
 170 </tr>
 171 <tr>
 172 <td>
 173                   <p>
 174                     <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>
 175                   </p>
 176                 </td>
 177 <td>
 178                   <p>
 179                     Get the stream's expiry time as an absolute time.
 180                   </p>
 181                   <p>
 182                     Set the stream's expiry time as an absolute time.
 183                   </p>
 184                 </td>
 185 </tr>
 186 <tr>
 187 <td>
 188                   <p>
 189                     <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>
 190                   </p>
 191                 </td>
 192 <td>
 193                   <p>
 194                     Get the timer's expiry time relative to now.
 195                   </p>
 196                   <p>
 197                     Set the stream's expiry time relative to now.
 198                   </p>
 199                 </td>
 200 </tr>
 201 <tr>
 202 <td>
 203                   <p>
 204                     <a class="link" href="../basic_socket_iostream/rdbuf.html" title="basic_socket_iostream::rdbuf"><span class="bold"><strong>rdbuf</strong></span></a>
 205                   </p>
 206                 </td>
 207 <td>
 208                   <p>
 209                     Return a pointer to the underlying streambuf.
 210                   </p>
 211                 </td>
 212 </tr>
 213 </tbody>
 214 </table></div>
 215 <h6>
 216 <a name="boost_asio.reference.local__stream_protocol.iostream.h2"></a>
 217           <span class="phrase"><a name="boost_asio.reference.local__stream_protocol.iostream.requirements"></a></span><a class="link" href="iostream.html#boost_asio.reference.local__stream_protocol.iostream.requirements">Requirements</a>
 218         </h6>
 219 <p>
 220           <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/local/stream_protocol.hpp</code>
 221         </p>
 222 <p>
 223           <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 224         </p>
 225 </div>
 226 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 227 <td align="left"></td>
 228 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 229         Distributed under the Boost Software License, Version 1.0. (See accompanying
 230         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>)
 231       </p>
 232 </div></td>
 233 </tr></table>
 234 <hr>
 235 <div class="spirit-nav">
 236 <a accesskey="p" href="family.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../local__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="protocol.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 237 </div>
 238 </body>
 239 </html>