Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

You've currently chosen the 1.91.0 version. If a newer release comes out, you will continue to view the 1.91.0 version, not the new latest release.

basic_seq_packet_socket::io_control (2 of 2 overloads)

basic_seq_packet_socket::io_control (2 of 2 overloads)

Inherited from basic_socket.

Perform an IO control command on the socket.

template<
    typename IoControlCommand>
void io_control(
    IoControlCommand & command,
    boost::system::error_code & ec);

This function is used to execute an IO control command on the socket.

Parameters

command: The IO control command to be performed on the socket.
ec: Set to indicate what error occurred, if any.

Example

Getting the number of bytes ready to read:

boost::asio::ip::tcp::socket socket(my_context);
...
boost::asio::ip::tcp::socket::bytes_readable command;
boost::system::error_code ec;
socket.io_control(command, ec);
if (ec)
{
  // An error occurred.
}
std::size_t bytes_readable = command.get();