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