Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

windows::object_handle

Provides object-oriented handle functionality.

class object_handle
Types

Name

Description

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.

cancel

Cancel all asynchronous operations associated with the handle.

close

Close the handle.

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.

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.

object_handle

Construct an object_handle without opening it.

Construct an object_handle on an existing native handle.

Move-construct an object_handle from another.

operator=

Move-assign an object_handle from another.

wait

Perform a blocking wait on the object handle.

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

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/windows/object_handle.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext