Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

windows::stream_handle

Provides stream-oriented handle functionality.

class stream_handle :
  public windows::overlapped_handle
Types

Name

Description

executor_type

The type of the executor associated with the object.

lowest_layer_type

An overlapped_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_read_some

Start an asynchronous read.

async_write_some

Start an asynchronous write.

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.

operator=

Move-assign a stream_handle from another.

read_some

Read some data from the handle.

stream_handle

Construct a stream_handle without opening it.

Construct a stream_handle on an existing native handle.

Move-construct a stream_handle from another.

write_some

Write some data to the handle.

The windows::stream_handle class provides asynchronous and blocking stream-oriented handle functionality.

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/windows/stream_handle.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext