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

experimental::basic_channel

A channel for messages.

template<
    typename Executor,
    typename Traits,
    typename... Signatures>
class basic_channel
Types

Name

Description

rebind_executor

Rebinds the channel type to another executor.

executor_type

The type of the executor associated with the channel.

traits_type

The traits type associated with the channel.

Member Functions

Name

Description

async_receive

Asynchronously receive a message.

async_send

Asynchronously send a message.

basic_channel [constructor]

Construct a basic_channel.

Construct and open a basic_channel.

Move-construct a basic_channel from another.

cancel

Cancel all asynchronous operations waiting on the channel.

capacity

Get the capacity of the channel's buffer.

close

Close the channel.

get_executor

Get the executor associated with the object.

is_open

Determine whether the channel is open.

operator=

Move-assign a basic_channel from another.

ready

Determine whether a message can be received without blocking.

reset

Reset the channel to its initial state.

try_receive

Try to receive a message without blocking.

try_send

Try to send a message without blocking.

try_send_n

Try to send a number of messages without blocking.

~basic_channel [destructor]

Destructor.

Requirements

Header: boost/asio/experimental/basic_channel.hpp

Convenience header: None


PrevUpHomeNext