<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>basic_raw_socket::io_control (1 of 2 overloads)</title> <link rel="stylesheet" href="../../../../boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" href="../../../../index.html" title="Asio"> <link rel="up" href="../io_control.html" title="basic_raw_socket::io_control"> <link rel="prev" href="../io_control.html" title="basic_raw_socket::io_control"> <link rel="next" href="overload2.html" title="basic_raw_socket::io_control (2 of 2 overloads)"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../../asio.png"></td></tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="../io_control.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a> </div> <div class="section" lang="en"> <div class="titlepage"><div><div><h5 class="title"> <a name="asio.reference.basic_raw_socket.io_control.overload1"></a><a class="link" href="overload1.html" title="basic_raw_socket::io_control (1 of 2 overloads)">basic_raw_socket::io_control (1 of 2 overloads)</a> </h5></div></div></div> <p> <span class="emphasis"><em>Inherited from basic_socket.</em></span> </p> <p> Perform an IO control command on the socket. </p> <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> <span class="keyword">typename</span> <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a><span class="special">></span> <span class="keyword">void</span> <span class="identifier">io_control</span><span class="special">(</span> <span class="identifier">IoControlCommand</span> <span class="special">&</span> <span class="identifier">command</span><span class="special">);</span> </pre> <p> This function is used to execute an IO control command on the socket. </p> <a name="asio.reference.basic_raw_socket.io_control.overload1.parameters"></a><h6> <a name="id804307"></a> <a class="link" href="overload1.html#asio.reference.basic_raw_socket.io_control.overload1.parameters">Parameters</a> </h6> <div class="variablelist"> <p class="title"><b></b></p> <dl> <dt><span class="term">command</span></dt> <dd><p> The IO control command to be performed on the socket. </p></dd> </dl> </div> <a name="asio.reference.basic_raw_socket.io_control.overload1.exceptions"></a><h6> <a name="id804347"></a> <a class="link" href="overload1.html#asio.reference.basic_raw_socket.io_control.overload1.exceptions">Exceptions</a> </h6> <div class="variablelist"> <p class="title"><b></b></p> <dl> <dt><span class="term">asio::system_error</span></dt> <dd><p> Thrown on failure. </p></dd> </dl> </div> <a name="asio.reference.basic_raw_socket.io_control.overload1.example"></a><h6> <a name="id804387"></a> <a class="link" href="overload1.html#asio.reference.basic_raw_socket.io_control.overload1.example">Example</a> </h6> <p> Getting the number of bytes ready to read: </p> <pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span> <span class="special">...</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">::</span><span class="identifier">bytes_readable</span> <span class="identifier">command</span><span class="special">;</span> <span class="identifier">socket</span><span class="special">.</span><span class="identifier">io_control</span><span class="special">(</span><span class="identifier">command</span><span class="special">);</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_readable</span> <span class="special">=</span> <span class="identifier">command</span><span class="special">.</span><span class="identifier">get</span><span class="special">();</span> </pre> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2003 - 2010 Christopher M. Kohlhoff<p> Distributed under the Boost Software License, Version 1.0. (See accompanying 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>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="../io_control.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_control.html"><img src="../../../../up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../next.png" alt="Next"></a> </div> </body> </html>