Document websocket::stream thread safety

fix #329
2017-05-05 10:01:18 -07:00
parent dc274afcfa
commit 84e173943b
2 changed files with 6 additions and 3 deletions
@@ -5,6 +5,7 @@
 WebSocket:

 * Add is_upgrade() free function
+* Document websocket::stream thread safety

 API Changes:

@@ -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