• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_stream_socket::wait (2 of 2 overloads)</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="../wait.html" title="basic_stream_socket::wait">
9<link rel="prev" href="overload1.html" title="basic_stream_socket::wait (1 of 2 overloads)">
10<link rel="next" href="../wait_type.html" title="basic_stream_socket::wait_type">
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="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="../wait_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="boost_asio.reference.basic_stream_socket.wait.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::wait (2 of 2 overloads)">basic_stream_socket::wait
28          (2 of 2 overloads)</a>
29</h5></div></div></div>
30<p>
31            <span class="emphasis"><em>Inherited from basic_socket.</em></span>
32          </p>
33<p>
34            Wait for the socket to become ready to read, ready to write, or to have
35            pending error conditions.
36          </p>
37<pre class="programlisting">void wait(
38    wait_type w,
39    boost::system::error_code &amp; ec);
40</pre>
41<p>
42            This function is used to perform a blocking wait for a socket to enter
43            a ready to read, write or error condition state.
44          </p>
45<h6>
46<a name="boost_asio.reference.basic_stream_socket.wait.overload2.h0"></a>
47            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.wait.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.wait.overload2.parameters">Parameters</a>
48          </h6>
49<div class="variablelist">
50<p class="title"><b></b></p>
51<dl class="variablelist">
52<dt><span class="term">w</span></dt>
53<dd><p>
54                  Specifies the desired socket state.
55                </p></dd>
56<dt><span class="term">ec</span></dt>
57<dd><p>
58                  Set to indicate what error occurred, if any.
59                </p></dd>
60</dl>
61</div>
62<h6>
63<a name="boost_asio.reference.basic_stream_socket.wait.overload2.h1"></a>
64            <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.wait.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.wait.overload2.example">Example</a>
65          </h6>
66<p>
67            Waiting for a socket to become readable.
68          </p>
69<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context);
70...
71boost::system::error_code ec;
72socket.wait(boost::asio::ip::tcp::socket::wait_read, ec);
73</pre>
74</div>
75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
76<td align="left"></td>
77<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
78      Kohlhoff<p>
79        Distributed under the Boost Software License, Version 1.0. (See accompanying
80        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>)
81      </p>
82</div></td>
83</tr></table>
84<hr>
85<div class="spirit-nav">
86<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="../wait_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
87</div>
88</body>
89</html>
90