diff --git a/CHANGELOG.md b/CHANGELOG.md index 64668e85..80c11224 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +Version 138: + +* Tidy up some documentation + +-------------------------------------------------------------------------------- + Version 137: * ConstBufferSequence mandates pointer equivalence diff --git a/include/boost/beast/http/read.hpp b/include/boost/beast/http/read.hpp index 96f2fff0..4f159aec 100644 --- a/include/boost/beast/http/read.hpp +++ b/include/boost/beast/http/read.hpp @@ -146,7 +146,7 @@ read_some( This operation is implemented in terms of zero or more calls to the next layer's `async_read_some` function, and is known as a composed operation. The program must ensure that the - stream performs no other operations until this operation completes. + stream performs no other reads until this operation completes. The implementation may read additional octets that lie past the end of the object being parsed. This additional data is stored in the stream buffer, which may be used in subsequent calls. @@ -332,7 +332,7 @@ read_header( This operation is implemented in terms of one or more calls to the stream's `async_read_some` function, and is known as a composed operation. The program must ensure that the - stream performs no other operations until this operation completes. + stream performs no other reads until this operation completes. The implementation may read additional octets that lie past the end of the message being read. This additional data is stored in the dynamic buffer, which must be retained for subsequent reads. @@ -516,7 +516,7 @@ read( This operation is implemented in terms of one or more calls to the stream's `async_read_some` function, and is known as a composed operation. The program must ensure that the - stream performs no other operations until this operation completes. + stream performs no other reads until this operation completes. The implementation may read additional octets that lie past the end of the message being read. This additional data is stored in the dynamic buffer, which must be retained for subsequent reads. @@ -698,7 +698,7 @@ read( This operation is implemented in terms of one or more calls to the stream's `async_read_some` function, and is known as a composed operation. The program must ensure that the - stream performs no other operations until this operation completes. + stream performs no other reads until this operation completes. The implementation may read additional octets that lie past the end of the message being read. This additional data is stored in the dynamic buffer, which must be retained for subsequent reads. diff --git a/include/boost/beast/http/write.hpp b/include/boost/beast/http/write.hpp index befc0fe7..755ed0b9 100644 --- a/include/boost/beast/http/write.hpp +++ b/include/boost/beast/http/write.hpp @@ -130,7 +130,7 @@ write_some( This operation is implemented in terms of zero or more calls to the stream's `async_write_some` function, and is known as a composed operation. - The program must ensure that the stream performs no other write operations + The program must ensure that the stream performs no other writes until this operation completes. The amount of data actually transferred is controlled by the behavior @@ -259,7 +259,7 @@ write_header( This operation is implemented in terms of zero or more calls to the stream's `async_write_some` function, and is known as a composed operation. - The program must ensure that the stream performs no other write operations + The program must ensure that the stream performs no other writes until this operation completes. @param stream The stream to which the data is to be written. @@ -377,7 +377,7 @@ write( This operation is implemented in terms of zero or more calls to the stream's `async_write_some` function, and is known as a composed operation. - The program must ensure that the stream performs no other write operations + The program must ensure that the stream performs no other writes until this operation completes. @param stream The stream to which the data is to be written. @@ -491,7 +491,7 @@ write( This operation is implemented in terms of zero or more calls to the stream's `async_write_some` function, and is known as a composed operation. - The program must ensure that the stream performs no other write operations + The program must ensure that the stream performs no other writes until this operation completes. The algorithm will use a temporary @ref serializer with an empty chunk decorator to produce buffers. diff --git a/include/boost/beast/websocket/stream.hpp b/include/boost/beast/websocket/stream.hpp index a3ab03ae..b6d10834 100644 --- a/include/boost/beast/websocket/stream.hpp +++ b/include/boost/beast/websocket/stream.hpp @@ -86,6 +86,8 @@ enum class frame_type @par Thread Safety @e Distinct @e objects: Safe.@n @e Shared @e objects: Unsafe. + The application must also ensure that all asynchronous + operations are performed within the same implicit or explicit strand. @par Example