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

Click here to view the latest version of this page.
PrevUpHomeNext
basic_serial_port::read_some (1 of 2 overloads)

Read some data from the serial port.

template<
    typename MutableBufferSequence>
std::size_t read_some(
    const MutableBufferSequence & buffers);

This function is used to read data from the serial port. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters

buffers

One or more buffers into which the data will be read.

Return Value

The number of bytes read.

Exceptions

boost::system::system_error

Thrown on failure. An error code of boost::asio::error::eof indicates that the connection was closed by the peer.

Remarks

The read_some operation may not read all of the requested number of bytes. Consider using the read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Example

To read into a single data buffer use the buffer function as follows:

serial_port.read_some(boost::asio::buffer(data, size));

See the buffer documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.


PrevUpHomeNext