diff --git a/CHANGELOG.md b/CHANGELOG.md index 72e922bf..dcb08701 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ WebSocket: * Add is_upgrade() free function +* Document websocket::stream thread safety API Changes: diff --git a/include/beast/websocket/stream.hpp b/include/beast/websocket/stream.hpp index 7a58481c..ae9b5ddb 100644 --- a/include/beast/websocket/stream.hpp +++ b/include/beast/websocket/stream.hpp @@ -58,9 +58,11 @@ struct frame_info @par Thread Safety @e Distinct @e objects: Safe.@n - @e Shared @e objects: Unsafe. The application must ensure that - all asynchronous operations are performed within the same - implicit or explicit strand. + @e Shared @e objects: Unsafe. + + For asynchronous operations, the application must ensure + that they are are all performed within the same implicit + or explicit strand. @par Example