Issue #2690 - clarify websocket message ordering in documentation

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2021-11-11 15:07:23 +11:00
parent 1acfcddd68
commit 5bfe2f47f5
2 changed files with 3 additions and 0 deletions

View File

@ -41,3 +41,4 @@ If your application needs specific features that are not provided by the standar
include::server-websocket-standard.adoc[]
include::server-websocket-jetty.adoc[]
include::server-websocket-filter.adoc[]
include::../../websocket.adoc[]

View File

@ -46,6 +46,8 @@ This event is emitted when the WebSocket communication encounters a fatal error,
Applications interested in the error event receive a `Throwable` that represent the error.
* The _message_ event.
The message event is emitted when a WebSocket message is received.
Only a single thread will be delivering a message event at any one time, and the next message event will not be triggered until the previous one has exited its onMessage method.
Endpoints will always be notified of message events in the same order they were received over the network.
The message event can be of two types:
** Textual message event.
Applications interested in this type of messages receive a `String` representing the UTF-8 bytes received.