boost::asio::basic_readable_pipe

Provides pipe functionality.

Synopsis

Declared in <boost/asio/basic_readable_pipe.hpp>

template<typename Executor = any_io_executor>
class basic_readable_pipe;

Types

Name

Description

rebind_executor

Rebinds the pipe type to another executor.

executor_type

The type of the executor associated with the object.

lowest_layer_type

A basic_readable_pipe is always the lowest layer.

native_handle_type

Member Functions

Name

Description

basic_readable_pipe [constructor]

Constructors

~basic_readable_pipe [destructor]

Destroys the pipe.

operator=

Assignment operators

assign

async_read_some

Start an asynchronous read.

cancel

Cancel all asynchronous operations associated with the pipe.

close

Close the pipe.

get_executor

Get the executor associated with the object.

is_open

Determine whether the pipe is open.

lowest_layer

lowest_layer overloads

native_handle

Get the native pipe representation.

read_some

Read some data from the pipe.

release

Friends

Name

Description

boost::asio::basic_readable_pipe

Provides pipe functionality.

Non-Member Functions

Name

Description

connect_pipe

Connect two pipe ends using an anonymous pipe.

connect_pipe

Connect two pipe ends using an anonymous pipe.

Description

The basic_readable_pipe class provides a wrapper over pipe functionality.

Thread Safety

Distinct objects: Safe. Shared objects: Unsafe.

Created with MrDocs