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

Update docs on stomp.js library 

Issue: SPR-15624
This commit is contained in:
Rossen Stoyanchev 2018-01-18 13:09:40 -05:00
parent 513461d4f1
commit 357fb48d13
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1043,16 +1043,20 @@ check the STOMP page of the broker to understand what kind of STOMP destinations
prefixes it supports. prefixes it supports.
==== ====
To connect from a browser, for SockJS you can use the
On the browser side, a client might connect as follows using https://github.com/sockjs/sockjs-client[sockjs-client]. For STOMP many applications have
https://github.com/jmesnil/stomp-websocket[stomp.js] and the used the https://github.com/jmesnil/stomp-websocket[jmesnil/stomp-websocket] library
https://github.com/sockjs/sockjs-client[sockjs-client]: (also known as stomp.js) which is feature complete and has been used in production for
years but is no longer maintained. At present the
https://github.com/JSteunou/webstomp-client[JSteunou/webstomp-client] is the most
actively maintained and evolving successor of that library and the example code below
is based on it:
[source,javascript,indent=0] [source,javascript,indent=0]
[subs="verbatim,quotes"] [subs="verbatim,quotes"]
---- ----
var socket = new SockJS("/spring-websocket-portfolio/portfolio"); var socket = new SockJS("/spring-websocket-portfolio/portfolio");
var stompClient = Stomp.over(socket); var stompClient = webstomp.over(socket);
stompClient.connect({}, function(frame) { stompClient.connect({}, function(frame) {
} }
@ -1075,6 +1079,13 @@ Even if it did, they would be ignored, or rather overridden, on the server side.
sections <<websocket-stomp-handle-broker-relay-configure>> and sections <<websocket-stomp-handle-broker-relay-configure>> and
<<websocket-stomp-authentication>> for more information on authentication. <<websocket-stomp-authentication>> for more information on authentication.
For a more example code see:
* https://spring.io/guides/gs/messaging-stomp-websocket/[Using WebSocket to build an
interactive web application] getting started guide.
* https://github.com/rstoyanchev/spring-websocket-portfolio[Stock Portfolio] sample
application.
[[websocket-stomp-message-flow]] [[websocket-stomp-message-flow]]
@ -2140,8 +2151,9 @@ The WebSocket transport configuration shown above can also be used to configure
maximum allowed size for incoming STOMP messages. Although in theory a WebSocket maximum allowed size for incoming STOMP messages. Although in theory a WebSocket
message can be almost unlimited in size, in practice WebSocket servers impose message can be almost unlimited in size, in practice WebSocket servers impose
limits -- for example, 8K on Tomcat and 64K on Jetty. For this reason STOMP clients limits -- for example, 8K on Tomcat and 64K on Jetty. For this reason STOMP clients
such as stomp.js split larger STOMP messages at 16K boundaries and send them as such as the JavaScript https://github.com/JSteunou/webstomp-client[webstomp-client]
multiple WebSocket messages thus requiring the server to buffer and re-assemble. and others split larger STOMP messages at 16K boundaries and send them as multiple
WebSocket messages thus requiring the server to buffer and re-assemble.
Spring's STOMP over WebSocket support does this so applications can configure the Spring's STOMP over WebSocket support does this so applications can configure the
maximum size for STOMP messages irrespective of WebSocket server specific message maximum size for STOMP messages irrespective of WebSocket server specific message