Write a certain amount of data at a specified offset before returning. More...

Functions
template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, const ConstBufferSequence &buffers)
	Write all of the supplied data at the specified offset before returning.
template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, const ConstBufferSequence &buffers, CompletionCondition completion_condition)
	Write a certain amount of data at a specified offset before returning.
template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, const ConstBufferSequence &buffers, CompletionCondition completion_condition, asio::error_code &ec)
	Write a certain amount of data at a specified offset before returning.
template<typename SyncRandomAccessWriteDevice , typename Allocator >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, basic_streambuf< Allocator > &b)
	Write all of the supplied data at the specified offset before returning.
template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, basic_streambuf< Allocator > &b, CompletionCondition completion_condition)
	Write a certain amount of data at a specified offset before returning.
template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >
std::size_t	asio::write_at (SyncRandomAccessWriteDevice &d, boost::uint64_t offset, basic_streambuf< Allocator > &b, CompletionCondition completion_condition, asio::error_code &ec)
	Write a certain amount of data at a specified offset before returning.

Detailed Description

Write a certain amount of data at a specified offset before returning.

Function Documentation

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		const ConstBufferSequence &	buffers
	)

Write all of the supplied data at the specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

An error occurred.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
buffers	One or more buffers containing the data to be written. The sum of the buffer sizes indicates the maximum number of bytes to write to the device.

Returns:: The number of bytes transferred.

Exceptions:

asio::system_error Thrown on failure.

Example

To write a single data buffer use the asio::buffer function as follows:

 asio::write_at(d, 42, asio::buffer(data, size));

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

Note:

This overload is equivalent to calling:

 asio::write_at(
     d, offset, buffers,
     asio::transfer_all());

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		const ConstBufferSequence &	buffers,
		CompletionCondition	completion_condition
	)

Write a certain amount of data at a specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

The completion_condition function object returns true.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
buffers	One or more buffers containing the data to be written. The sum of the buffer sizes indicates the maximum number of bytes to write to the device.
completion_condition	The function object to be called to determine whether the write operation is complete. The signature of the function object must be: bool completion_condition( // Result of latest write_some_at operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of true indicates that the write operation is complete. False indicates that further calls to the device's write_some_at function are required.

Returns:: The number of bytes transferred.

Exceptions:

asio::system_error Thrown on failure.

Example

To write a single data buffer use the asio::buffer function as follows:

 asio::write_at(d, 42, asio::buffer(data, size),
     asio::transfer_at_least(32));

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

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		const ConstBufferSequence &	buffers,
		CompletionCondition	completion_condition,
		asio::error_code &	ec
	)

Write a certain amount of data at a specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

The completion_condition function object returns true.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
buffers	One or more buffers containing the data to be written. The sum of the buffer sizes indicates the maximum number of bytes to write to the device.
completion_condition	The function object to be called to determine whether the write operation is complete. The signature of the function object must be: bool completion_condition( // Result of latest write_some_at operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of true indicates that the write operation is complete. False indicates that further calls to the device's write_some_at function are required.
ec	Set to indicate what error occurred, if any.

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

template<typename SyncRandomAccessWriteDevice , typename Allocator >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		basic_streambuf< Allocator > &	b
	)

Write all of the supplied data at the specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied basic_streambuf has been written.

An error occurred.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
b	The basic_streambuf object from which data will be written.

Returns:: The number of bytes transferred.

Exceptions:

asio::system_error Thrown on failure.

Note:

This overload is equivalent to calling:

 asio::write_at(
     d, 42, b,
     asio::transfer_all());

template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		basic_streambuf< Allocator > &	b,
		CompletionCondition	completion_condition
	)

Write a certain amount of data at a specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied basic_streambuf has been written.

The completion_condition function object returns true.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
b	The basic_streambuf object from which data will be written.
completion_condition	The function object to be called to determine whether the write operation is complete. The signature of the function object must be: bool completion_condition( // Result of latest write_some_at operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of true indicates that the write operation is complete. False indicates that further calls to the device's write_some_at function are required.

Returns:: The number of bytes transferred.

Exceptions:

asio::system_error Thrown on failure.

template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		boost::uint64_t	offset,
		basic_streambuf< Allocator > &	b,
		CompletionCondition	completion_condition,
		asio::error_code &	ec
	)

Write a certain amount of data at a specified offset before returning.

This function is used to write a certain number of bytes of data to a random access device at a specified offset. The call will block until one of the following conditions is true:

All of the data in the supplied basic_streambuf has been written.

The completion_condition function object returns true.

This operation is implemented in terms of one or more calls to the device's write_some_at function.

Parameters:

d	The device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
b	The basic_streambuf object from which data will be written.
completion_condition	The function object to be called to determine whether the write operation is complete. The signature of the function object must be: bool completion_condition( // Result of latest write_some_at operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of true indicates that the write operation is complete. False indicates that further calls to the device's write_some_at function are required.
ec	Set to indicate what error occurred, if any.

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

Functions

Detailed Description

Function Documentation