diff options
Diffstat (limited to '3rdparty/asio/src/doc/requirements/read_write_operations.qbk')
-rw-r--r-- | 3rdparty/asio/src/doc/requirements/read_write_operations.qbk | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/3rdparty/asio/src/doc/requirements/read_write_operations.qbk b/3rdparty/asio/src/doc/requirements/read_write_operations.qbk new file mode 100644 index 00000000000..d7185a9beaf --- /dev/null +++ b/3rdparty/asio/src/doc/requirements/read_write_operations.qbk @@ -0,0 +1,34 @@ +[/ + / Copyright (c) 2003-2016 Christopher M. Kohlhoff (chris at kohlhoff dot com) + / + / Distributed under the Boost Software License, Version 1.0. (See accompanying + / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + /] + +[section:read_write_operations Requirements on read and write operations] + +A ['read operation] is an operation that reads data into a mutable buffer +sequence argument of a type meeting [link asio.reference.MutableBufferSequence +`MutableBufferSequence`] requirements. The mutable buffer sequence specifies +memory where the data should be placed. A read operation shall always fill a +buffer in the sequence completely before proceeding to the next. + +A ['write operation] is an operation that writes data from a constant buffer +sequence argument of a type meeting [link asio.reference.ConstBufferSequence +`ConstBufferSequence`] requirements. The constant buffer sequence specifies +memory where the data to be written is located. A write operation shall always +write a buffer in the sequence completely before proceeding to the next. + +If a read or write operation is also an [link +asio.reference.asynchronous_operations asynchronous operation], the operation +shall maintain one or more copies of the buffer sequence until such time as the +operation no longer requires access to the memory specified by the buffers in +the sequence. The program shall ensure the memory remains valid until: + +[mdash] the last copy of the buffer sequence is destroyed, or + +[mdash] the completion handler for the asynchronous operation is invoked, + +whichever comes first. + +[endsect] |