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

serial_port

Typedef for the typical usage of a serial port.

typedef basic_serial_port serial_port;
Types

Name

Description

rebind_executor

Rebinds the serial port type to another executor.

executor_type

The type of the executor associated with the object.

lowest_layer_type

A basic_basic_serial_port is always the lowest layer.

native_handle_type

The native representation of a serial port.

Member Functions

Name

Description

assign

Assign an existing native serial port to the serial port.

async_read_some

Start an asynchronous read.

async_write_some

Start an asynchronous write.

basic_serial_port [constructor]

Construct a basic_serial_port without opening it.

Construct and open a basic_serial_port.

Construct a basic_serial_port on an existing native serial port.

Move-construct a basic_serial_port from another.

cancel

Cancel all asynchronous operations associated with the serial port.

close

Close the serial port.

get_executor

Get the executor associated with the object.

get_option

Get an option from the serial port.

is_open

Determine whether the serial port is open.

lowest_layer

Get a reference to the lowest layer.

Get a const reference to the lowest layer.

native_handle

Get the native serial port representation.

open

Open the serial port using the specified device name.

operator=

Move-assign a basic_serial_port from another.

read_some

Read some data from the serial port.

send_break

Send a break sequence to the serial port.

set_option

Set an option on the serial port.

write_some

Write some data to the serial port.

~basic_serial_port [destructor]

Destroys the serial port.

The basic_serial_port class provides a wrapper over serial port functionality.

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/serial_port.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext