Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::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 boost::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 boost::asio::write_at (SyncRandomAccessWriteDevice &d, uint64_t offset, const ConstBufferSequence &buffers, boost::system::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 boost::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 boost::asio::write_at (SyncRandomAccessWriteDevice &d, uint64_t offset, const ConstBufferSequence &buffers, CompletionCondition completion_condition, boost::system::error_code &ec)
 Write a certain amount of data at a specified offset before returning. More...
 
template<typename SyncRandomAccessWriteDevice , typename Allocator >
std::size_t boost::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 boost::asio::write_at (SyncRandomAccessWriteDevice &d, uint64_t offset, basic_streambuf< Allocator > &b, boost::system::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 boost::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 boost::asio::write_at (SyncRandomAccessWriteDevice &d, uint64_t offset, basic_streambuf< Allocator > &b, CompletionCondition completion_condition, boost::system::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 >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
const ConstBufferSequence &  buffers 
)

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

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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
buffersOne 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
boost::system::system_errorThrown on failure.
Example
To write a single data buffer use the boost::asio::buffer function as follows: See the boost::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:
template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
const ConstBufferSequence &  buffers,
boost::system::error_code ec 
)

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

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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
buffersOne 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.
ecSet to indicate what error occurred, if any.
Returns
The number of bytes transferred.
Example
To write a single data buffer use the boost::asio::buffer function as follows:
boost::asio::buffer(data, size), ec);
See the boost::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:
template<typename SyncRandomAccessWriteDevice , typename ConstBufferSequence , typename CompletionCondition >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
const ConstBufferSequence &  buffers,
CompletionCondition  completion_condition 
)

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

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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
buffersOne 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_conditionThe 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.
// 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
boost::system::system_errorThrown on failure.
Example
To write a single data buffer use the boost::asio::buffer function as follows: See the boost::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 boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
const ConstBufferSequence &  buffers,
CompletionCondition  completion_condition,
boost::system::error_code ec 
)

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

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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
buffersOne 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_conditionThe 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.
// 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.
ecSet 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 boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
basic_streambuf< Allocator > &  b 
)

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

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:

  • An error occurred.

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

Parameters
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
bThe basic_streambuf object from which data will be written.
Returns
The number of bytes transferred.
Exceptions
boost::system::system_errorThrown on failure.
Note
This overload is equivalent to calling:
template<typename SyncRandomAccessWriteDevice , typename Allocator >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
basic_streambuf< Allocator > &  b,
boost::system::error_code ec 
)

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

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:

  • An error occurred.

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

Parameters
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
bThe basic_streambuf object from which data will be written.
ecSet to indicate what error occurred, if any.
Returns
The number of bytes transferred.
Note
This overload is equivalent to calling:
template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
basic_streambuf< Allocator > &  b,
CompletionCondition  completion_condition 
)

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

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:

  • 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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
bThe basic_streambuf object from which data will be written.
completion_conditionThe 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.
// 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
boost::system::system_errorThrown on failure.
template<typename SyncRandomAccessWriteDevice , typename Allocator , typename CompletionCondition >
std::size_t boost::asio::write_at ( SyncRandomAccessWriteDevice &  d,
uint64_t  offset,
basic_streambuf< Allocator > &  b,
CompletionCondition  completion_condition,
boost::system::error_code ec 
)

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

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:

  • 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
dThe device to which the data is to be written. The type must support the SyncRandomAccessWriteDevice concept.
offsetThe offset at which the data will be written.
bThe basic_streambuf object from which data will be written.
completion_conditionThe 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.
// 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.
ecSet 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.