boost::asio::windows::basic_object_handle

Provides object‐oriented handle functionality.

Synopsis

Declared in <boost/asio/windows/basic_object_handle.hpp>

template<typename Executor = any_io_executor>
class basic_object_handle;

Types

Name

Description

rebind_executor

Rebinds the handle type to another executor.

executor_type

The type of the executor associated with the object.

lowest_layer_type

An object handle is always the lowest layer.

native_handle_type

Member Functions

Name

Description

basic_object_handle [constructor]

Constructors

operator=

Assignment operators

assign

async_wait

Start an asynchronous wait on the object handle.

cancel

Cancel all asynchronous operations associated with the handle.

close

Close the handle.

get_executor

Get the executor associated with the object.

is_open

Determine whether the handle is open.

lowest_layer

lowest_layer overloads

native_handle

Get the native handle representation.

wait

Perform a blocking wait on the object handle.

Friends

Name

Description

boost::asio::windows::basic_object_handle

Provides object‐oriented handle functionality.

Description

The windows::basic_object_handle class provides asynchronous and blocking object‐oriented handle functionality.

Thread Safety

Distinct objects: Safe. Shared objects: Unsafe.

Created with MrDocs