Issue #2690 - clarify websocket message ordering in documentation #7097
Conversation
Signed-off-by: Lachlan Roberts <[email protected]>
| @@ -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[] | |||
There was a problem hiding this comment.
@sbordet I thought websocket.adoc was the common section which was supposed to be in both client and server websocket documentation. I couldn't see it in the Server side documentation I have added this here.
There was a problem hiding this comment.
I don't think it's the right place, as it speaks about Jetty-specific annotations and classes, so perhaps it should be an include inside server-websocket-jetty.adoc.
I could not write a generic WebSocket architecture, since you have to refer to annotation and classes that are specific.
Also, including it in the server will cause duplicate links, so perhaps for the server documentation I would just add a paragraph that says something like "for the Jetty WebSocket architecture read xref:..." and point to the client docs (rather than including it again).
There was a problem hiding this comment.
I have reverted this change, looks like there is already some links to it from the Server documentation. Just seems strange that the common websocket documentation is contained within the client section.
| @@ -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. | |||
There was a problem hiding this comment.
| 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. | |
| Only one thread at a time will be delivering a message event to the `@OnMessage` method; the next message event will not be delivered until the previous call to the `@OnMessage` method has exited. |
There was a problem hiding this comment.
I didn't want to use that specific @OnMessage annotation because this that annotation is specific to javax.websocket. This is talking about a more general message event which could be a method from a listener class or the @OnWebSocketMessage annotation from Jetty API.
| @@ -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[] | |||
There was a problem hiding this comment.
I don't think it's the right place, as it speaks about Jetty-specific annotations and classes, so perhaps it should be an include inside server-websocket-jetty.adoc.
I could not write a generic WebSocket architecture, since you have to refer to annotation and classes that are specific.
Also, including it in the server will cause duplicate links, so perhaps for the server documentation I would just add a paragraph that says something like "for the Jetty WebSocket architecture read xref:..." and point to the client docs (rather than including it again).
Signed-off-by: Lachlan Roberts <[email protected]>
closes #2690