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

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext

windows::basic_object_handle

Provides object-oriented handle functionality.

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

The native representation of a handle.

Member Functions

Name

Description

assign

Assign an existing native handle to the handle.

async_wait

Start an asynchronous wait on the object handle.

basic_object_handle [constructor]

Construct an object handle without opening it.

Construct an object handle on an existing native handle.

Move-construct an object handle from another.

Move-construct an object handle from a handle of another executor type.

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

Get a reference to the lowest layer.

Get a const reference to the lowest layer.

native_handle

Get the native handle representation.

operator=

Move-assign an object handle from another.

Move-assign an object handle from a handle of another executor type.

wait

Perform a blocking wait on the object handle.

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

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/windows/basic_object_handle.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext