posix::descriptor

Provides POSIX descriptor functionality.

class descriptor :
  public posix::descriptor_base

Types

Name	Description
bytes_readable	IO control command to get the amount of data that can be read without blocking.
executor_type	The type of the executor associated with the object.
lowest_layer_type	A descriptor is always the lowest layer.
native_handle_type	The native representation of a descriptor.
wait_type	Wait types.

Member Functions

Name	Description
assign	Assign an existing native descriptor to the descriptor.
async_wait	Asynchronously wait for the descriptor to become ready to read, ready to write, or to have pending error conditions.
cancel	Cancel all asynchronous operations associated with the descriptor.
close	Close the descriptor.
descriptor	Construct a descriptor without opening it. — Construct a descriptor on an existing native descriptor. — Move-construct a descriptor from another.
get_executor	Get the executor associated with the object.
get_io_context	(Deprecated: Use get_executor().) Get the io_context associated with the object.
get_io_service	(Deprecated: Use get_executor().) Get the io_context associated with the object.
io_control	Perform an IO control command on the descriptor.
is_open	Determine whether the descriptor is open.
lowest_layer	Get a reference to the lowest layer. — Get a const reference to the lowest layer.
native_handle	Get the native descriptor representation.
native_non_blocking	Gets the non-blocking mode of the native descriptor implementation. — Sets the non-blocking mode of the native descriptor implementation.
non_blocking	Gets the non-blocking mode of the descriptor. — Sets the non-blocking mode of the descriptor.
operator=	Move-assign a descriptor from another.
release	Release ownership of the native descriptor implementation.
wait	Wait for the descriptor to become ready to read, ready to write, or to have pending error conditions.

Protected Member Functions

Name	Description
~descriptor	Protected destructor to prevent deletion through this type.

The posix::descriptor class template provides the ability to wrap a POSIX descriptor.

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/posix/descriptor.hpp

Convenience header: boost/asio.hpp