1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_stream_socket::io_control (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="../io_control.html" title="basic_stream_socket::io_control"> 9<link rel="prev" href="overload1.html" title="basic_stream_socket::io_control (1 of 2 overloads)"> 10<link rel="next" href="../is_open.html" title="basic_stream_socket::is_open"> 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="../io_control.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="../is_open.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.io_control.overload2"></a><a class="link" href="overload2.html" title="basic_stream_socket::io_control (2 of 2 overloads)">basic_stream_socket::io_control 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 Perform an IO control command on the socket. 35 </p> 36<pre class="programlisting">template< 37 typename <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>> 38void io_control( 39 IoControlCommand & command, 40 boost::system::error_code & ec); 41</pre> 42<p> 43 This function is used to execute an IO control command on the socket. 44 </p> 45<h6> 46<a name="boost_asio.reference.basic_stream_socket.io_control.overload2.h0"></a> 47 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.io_control.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.io_control.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">command</span></dt> 53<dd><p> 54 The IO control command to be performed on the socket. 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.io_control.overload2.h1"></a> 64 <span class="phrase"><a name="boost_asio.reference.basic_stream_socket.io_control.overload2.example"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_stream_socket.io_control.overload2.example">Example</a> 65 </h6> 66<p> 67 Getting the number of bytes ready to read: 68 </p> 69<pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context); 70... 71boost::asio::ip::tcp::socket::bytes_readable command; 72boost::system::error_code ec; 73socket.io_control(command, ec); 74if (ec) 75{ 76 // An error occurred. 77} 78std::size_t bytes_readable = command.get(); 79</pre> 80</div> 81<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 82<td align="left"></td> 83<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 84 Kohlhoff<p> 85 Distributed under the Boost Software License, Version 1.0. (See accompanying 86 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>) 87 </p> 88</div></td> 89</tr></table> 90<hr> 91<div class="spirit-nav"> 92<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.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="../is_open.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 93</div> 94</body> 95</html> 96
