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