asio::write_at

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

Detailed Description

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

Function Documentation

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		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 0.

This operation is implemented in terms of zero 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: std::size_t 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 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the device's write_some_at function.
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.

Definition at line 37 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence >

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

inline

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 zero 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()); 

Definition at line 60 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence >

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

inline

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 zero 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.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes transferred.

Example

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

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

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(), ec); 

Definition at line 71 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >

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

inline

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 0.

This operation is implemented in terms of zero 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: std::size_t 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 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the device's write_some_at function.

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.

Definition at line 80 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >

std::size_t asio::write_at	(	SyncRandomAccessWriteDevice &	d,
		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 0.

This operation is implemented in terms of zero 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: std::size_t 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 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the device's write_some_at function.
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.

Definition at line 95 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename Allocator >

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

inline

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 zero 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()); 

Definition at line 106 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename Allocator >

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

inline

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 zero 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.
ec	Set to indicate what error occurred, if any.

Returns

The number of bytes transferred.

Note

This overload is equivalent to calling:

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

Definition at line 116 of file write_at.hpp.

template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >

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

inline

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 0.

This operation is implemented in terms of zero 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: std::size_t 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 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the device's write_some_at function.

Returns

The number of bytes transferred.

Exceptions

asio::system_error

Thrown on failure.

Definition at line 125 of file write_at.hpp.