| Home | Libraries | People | FAQ | More

### posix::stream_descriptor

Provides stream-oriented descriptor functionality.

    class stream_descriptor :
      public posix::descriptor

##### 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_read_some | Start an asynchronous read.
async_wait | Asynchronously wait for the descriptor to become ready to read, ready to write, or to have pending error conditions.
async_write_some | Start an asynchronous write.
cancel | Cancel all asynchronous operations associated with the descriptor.
close | Close the descriptor.
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 stream_descriptor from another.
read_some | Read some data from the descriptor.
release | Release ownership of the native descriptor implementation.
stream_descriptor | Construct a stream_descriptor without opening it. Construct a stream_descriptor on an existing native descriptor. Move-construct a stream_descriptor from another.
wait | Wait for the descriptor to become ready to read, ready to write, or to have pending error conditions.
write_some | Write some data to the descriptor.

The `posix::stream_descriptor` class template provides asynchronous and blocking stream-oriented descriptor functionality.

##### Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

##### Requirements

Header: `boost/asio/posix/stream_descriptor.hpp`

Convenience header: `boost/asio.hpp`