Document websocket::stream thread safety

fix #329
This commit is contained in:
Vinnie Falco
2017-04-27 17:21:57 -07:00
parent 4b3a21efec
commit 4b02fe989f
2 changed files with 6 additions and 3 deletions

View File

@@ -5,6 +5,7 @@
WebSocket: WebSocket:
* Add is_upgrade() free function * Add is_upgrade() free function
* Document websocket::stream thread safety
API Changes: API Changes:

View File

@@ -58,9 +58,11 @@ struct frame_info
@par Thread Safety @par Thread Safety
@e Distinct @e objects: Safe.@n @e Distinct @e objects: Safe.@n
@e Shared @e objects: Unsafe. The application must ensure that @e Shared @e objects: Unsafe.
all asynchronous operations are performed within the same
implicit or explicit strand. For asynchronous operations, the application must ensure
that they are are all performed within the same implicit
or explicit strand.
@par Example @par Example