doc/html/boost_asio/reference/basic_seq_packet_socket/io_control/overload1.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_seq_packet_socket::io_control (1 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_seq_packet_socket::io_control">
   9 <link rel="prev" href="../io_control.html" title="basic_seq_packet_socket::io_control">
  10 <link rel="next" href="overload2.html" title="basic_seq_packet_socket::io_control (2 of 2 overloads)">
  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="../io_control.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="overload2.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_seq_packet_socket.io_control.overload1"></a><a class="link" href="overload1.html" title="basic_seq_packet_socket::io_control (1 of 2 overloads)">basic_seq_packet_socket::io_control
  28           (1 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&lt;
  37     typename <a class="link" href="../../IoControlCommand.html" title="I/O control command requirements">IoControlCommand</a>&gt;
  38 void io_control(
  39     IoControlCommand &amp; command);
  40 </pre>
  41 <p>
  42             This function is used to execute an IO control command on the socket.
  43           </p>
  44 <h6>
  45 <a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.h0"></a>
  46             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.io_control.overload1.parameters">Parameters</a>
  47           </h6>
  48 <div class="variablelist">
  49 <p class="title"><b></b></p>
  50 <dl class="variablelist">
  51 <dt><span class="term">command</span></dt>
  52 <dd><p>
  53                   The IO control command to be performed on the socket.
  54                 </p></dd>
  55 </dl>
  56 </div>
  57 <h6>
  58 <a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.h1"></a>
  59             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.io_control.overload1.exceptions">Exceptions</a>
  60           </h6>
  61 <div class="variablelist">
  62 <p class="title"><b></b></p>
  63 <dl class="variablelist">
  64 <dt><span class="term">boost::system::system_error</span></dt>
  65 <dd><p>
  66                   Thrown on failure.
  67                 </p></dd>
  68 </dl>
  69 </div>
  70 <h6>
  71 <a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.h2"></a>
  72             <span class="phrase"><a name="boost_asio.reference.basic_seq_packet_socket.io_control.overload1.example"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_seq_packet_socket.io_control.overload1.example">Example</a>
  73           </h6>
  74 <p>
  75             Getting the number of bytes ready to read:
  76           </p>
  77 <pre class="programlisting">boost::asio::ip::tcp::socket socket(my_context);
  78 ...
  79 boost::asio::ip::tcp::socket::bytes_readable command;
  80 socket.io_control(command);
  81 std::size_t bytes_readable = command.get();
  82 </pre>
  83 </div>
  84 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  85 <td align="left"></td>
  86 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2019 Christopher M. Kohlhoff<p>
  87         Distributed under the Boost Software License, Version 1.0. (See accompanying
  88         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>)
  89       </p>
  90 </div></td>
  91 </tr></table>
  92 <hr>
  93 <div class="spirit-nav">
  94 <a accesskey="p" href="../io_control.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="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  95 </div>
  96 </body>
  97 </html>