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