root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Add reference to ConcurrentWebSocketSessionDecorator in the docs. 

Issue: SPR-12886
This commit is contained in:
Rossen Stoyanchev 2018-12-12 11:57:51 -05:00
parent 388ce92861
commit 14e87d2733
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
spring-websocket/src/main/java/org/springframework/web/socket/WebSocketSession.java
View File

@ -120,6 +120,13 @@ public interface WebSocketSession extends Closeable {
/** /**
* Send a WebSocket message: either {@link TextMessage} or {@link BinaryMessage}. * Send a WebSocket message: either {@link TextMessage} or {@link BinaryMessage}.
*
* <p><strong>Note:</strong> The underlying standard WebSocket session (JSR-356) does
* not allow concurrent sending. Therefore sending must be synchronized. To ensure
* that, one option is to wrap the {@code WebSocketSession} with the
* {@link org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
* ConcurrentWebSocketSessionDecorator}.
* @see org.springframework.web.socket.handler.ConcurrentWebSocketSessionDecorator
*/ */
void sendMessage(WebSocketMessage<?> message) throws IOException; void sendMessage(WebSocketMessage<?> message) throws IOException;

8
src/docs/asciidoc/web/websocket.adoc
View File

@ -102,12 +102,18 @@ The following example shows the XML configuration equivalent of the preceding ex
---- ----
==== ====
The pereceding example is for use in Spring MVC applications and should be included in the The preceding example is for use in Spring MVC applications and should be included in the
configuration of a <<mvc-servlet,`DispatcherServlet`>>. However, Spring's WebSocket configuration of a <<mvc-servlet,`DispatcherServlet`>>. However, Spring's WebSocket
support does not depend on Spring MVC. It is relatively simple to integrate a `WebSocketHandler` support does not depend on Spring MVC. It is relatively simple to integrate a `WebSocketHandler`
into other HTTP-serving environments with the help of into other HTTP-serving environments with the help of
{api-spring-framework}/web/socket/server/support/WebSocketHttpRequestHandler.html[`WebSocketHttpRequestHandler`]. {api-spring-framework}/web/socket/server/support/WebSocketHttpRequestHandler.html[`WebSocketHttpRequestHandler`].
When using the `WebSocketHandler` API directly vs indirectly, e.g. through the
<<websocket-stomp>> messaging, the application must synchronize the sending of messages
since the underlying standard WebSocket session (JSR-356) does not allow concurrent
sending. One option is to wrap the `WebSocketSession` with
{api-spring-framework}/web/socket/handler/ConcurrentWebSocketSessionDecorator.html[`ConcurrentWebSocketSessionDecorator`].
[[websocket-server-handshake]] [[websocket-server-handshake]]