boost::asio::read

Attempt to read a certain amount of data from a stream before returning. More...

Functions
template<typename SyncReadStream , typename MutableBufferSequence >
std::size_t	boost::asio::read (SyncReadStream &s, const MutableBufferSequence &buffers)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename MutableBufferSequence >
std::size_t	boost::asio::read (SyncReadStream &s, const MutableBufferSequence &buffers, boost::system::error_code &ec)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename MutableBufferSequence , typename CompletionCondition >
std::size_t	boost::asio::read (SyncReadStream &s, const MutableBufferSequence &buffers, CompletionCondition completion_condition)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename MutableBufferSequence , typename CompletionCondition >
std::size_t	boost::asio::read (SyncReadStream &s, const MutableBufferSequence &buffers, CompletionCondition completion_condition, boost::system::error_code &ec)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename Allocator >
std::size_t	boost::asio::read (SyncReadStream &s, basic_streambuf< Allocator > &b)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename Allocator >
std::size_t	boost::asio::read (SyncReadStream &s, basic_streambuf< Allocator > &b, boost::system::error_code &ec)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename Allocator , typename CompletionCondition >
std::size_t	boost::asio::read (SyncReadStream &s, basic_streambuf< Allocator > &b, CompletionCondition completion_condition)
	Attempt to read a certain amount of data from a stream before returning. More...
template<typename SyncReadStream , typename Allocator , typename CompletionCondition >
std::size_t	boost::asio::read (SyncReadStream &s, basic_streambuf< Allocator > &b, CompletionCondition completion_condition, boost::system::error_code &ec)
	Attempt to read a certain amount of data from a stream before returning. More...

Detailed Description

Attempt to read a certain amount of data from a stream before returning.

Function Documentation

template<typename SyncReadStream , typename MutableBufferSequence >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		const MutableBufferSequence &	buffers
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.

• An error occurred.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
buffers	One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.

Returns

The number of bytes transferred.

Exceptions

boost::system::system_error

Thrown on failure.

Example

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

boost::asio::read(s, boost::asio::buffer(data, size)); 

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

Note

This overload is equivalent to calling:

boost::asio::read(
   s, buffers,
   boost::asio::transfer_all()); 

Referenced by boost::iostreams::basic_gzip_compressor< Alloc >::read(), boost::iostreams::basic_gzip_decompressor< Alloc >::read(), and boost::iostreams::read_if().

template<typename SyncReadStream , typename MutableBufferSequence >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		const MutableBufferSequence &	buffers,
		boost::system::error_code &	ec
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.

• An error occurred.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
buffers	One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes transferred.

Example

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

boost::asio::read(s, boost::asio::buffer(data, size), ec); 

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

Note

This overload is equivalent to calling:

boost::asio::read(
   s, buffers,
   boost::asio::transfer_all(), ec); 

template<typename SyncReadStream , typename MutableBufferSequence , typename CompletionCondition >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		const MutableBufferSequence &	buffers,
		CompletionCondition	completion_condition
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.

• The completion_condition function object returns 0.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
buffers	One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.
completion_condition	The function object to be called to determine whether the read operation is complete. The signature of the function object must be: std::size_t completion_condition( // Result of latest read_some operation. const boost::system::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read_some function.

Returns

The number of bytes transferred.

Exceptions

boost::system::system_error

Thrown on failure.

Example

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

boost::asio::read(s, boost::asio::buffer(data, size),
   boost::asio::transfer_at_least(32)); 

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

template<typename SyncReadStream , typename MutableBufferSequence , typename CompletionCondition >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		const MutableBufferSequence &	buffers,
		CompletionCondition	completion_condition,
		boost::system::error_code &	ec
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.

• The completion_condition function object returns 0.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
buffers	One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.
completion_condition	The function object to be called to determine whether the read operation is complete. The signature of the function object must be: std::size_t completion_condition( // Result of latest read_some operation. const boost::system::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read_some function.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.

template<typename SyncReadStream , typename Allocator >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		basic_streambuf< Allocator > &	b
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffer is full (that is, it has reached maximum size).

• An error occurred.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
b	The basic_streambuf object into which the data will be read.

Returns

The number of bytes transferred.

Exceptions

boost::system::system_error

Thrown on failure.

Note

This overload is equivalent to calling:

boost::asio::read(
   s, b,
   boost::asio::transfer_all()); 

template<typename SyncReadStream , typename Allocator >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		basic_streambuf< Allocator > &	b,
		boost::system::error_code &	ec
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffer is full (that is, it has reached maximum size).

• An error occurred.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
b	The basic_streambuf object into which the data will be read.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes transferred.

Note

This overload is equivalent to calling:

boost::asio::read(
   s, b,
   boost::asio::transfer_all(), ec); 

template<typename SyncReadStream , typename Allocator , typename CompletionCondition >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		basic_streambuf< Allocator > &	b,
		CompletionCondition	completion_condition
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffer is full (that is, it has reached maximum size).

• The completion_condition function object returns 0.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
b	The basic_streambuf object into which the data will be read.
completion_condition	The function object to be called to determine whether the read operation is complete. The signature of the function object must be: std::size_t completion_condition( // Result of latest read_some operation. const boost::system::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read_some function.

Returns

The number of bytes transferred.

Exceptions

boost::system::system_error

Thrown on failure.

template<typename SyncReadStream , typename Allocator , typename CompletionCondition >

std::size_t boost::asio::read	(	SyncReadStream &	s,
		basic_streambuf< Allocator > &	b,
		CompletionCondition	completion_condition,
		boost::system::error_code &	ec
	)

#include <boost_1_57_0/boost/asio/read.hpp>

Attempt to read a certain amount of data from a stream before returning.

This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:

• The supplied buffer is full (that is, it has reached maximum size).

• The completion_condition function object returns 0.

This operation is implemented in terms of zero or more calls to the stream's read_some function.

Parameters

s	The stream from which the data is to be read. The type must support the SyncReadStream concept.
b	The basic_streambuf object into which the data will be read.
completion_condition	The function object to be called to determine whether the read operation is complete. The signature of the function object must be: std::size_t completion_condition( // Result of latest read_some operation. const boost::system::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read_some function.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.