Skip to content

Commit a770b15

Browse files
committed
Specify SockJS protocol and client supported versions
In order to avoid breaking changed due to the upcoming SockJS 1.0 release (see SPR-12422 for more details) and link to the right SockJS documentation version, we now explicitly specify that we support SockJS protocol 0.3.3 and SockJS client 0.3.x.
1 parent ea05e0b commit a770b15

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

src/asciidoc/index.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39469,7 +39469,8 @@ or WebSocket XML namespace:
3946939469
As explained in the <<websocket-into-fallback-options,introduction>>, WebSocket is not
3947039470
supported in all browsers yet and may be precluded by restrictive network proxies.
3947139471
This is why Spring provides fallback options that emulate the WebSocket API as close
39472-
as possible based on the https://github.com/sockjs/sockjs-protocol[SockJS protocol].
39472+
as possible based on the https://github.com/sockjs/sockjs-protocol[SockJS protocol]
39473+
(version 0.3.3).
3947339474

3947439475
[[websocket-fallback-sockjs-overview]]
3947539476
==== Overview of SockJS
@@ -39483,14 +39484,14 @@ SockJS consists of:
3948339484
* The https://github.com/sockjs/sockjs-protocol[SockJS protocol]
3948439485
defined in the form of executable
3948539486
http://sockjs.github.io/sockjs-protocol/sockjs-protocol-0.3.3.html[narrated tests].
39486-
* The https://github.com/sockjs/sockjs-client[SockJS JavaScript client] - a client library for use in browsers.
39487+
* The https://github.com/sockjs/sockjs-client/tree/v0.3.4[SockJS JavaScript client] - a client library for use in browsers.
3948739488
* SockJS server implementations including one in the Spring Framework `spring-websocket` module.
3948839489
* As of 4.1 `spring-websocket` also provides a SockJS Java client.
3948939490

3949039491
SockJS is designed for use in browsers. It goes to great lengths
3949139492
to support a wide range of browser versions using a variety of techniques.
3949239493
For the full list of SockJS transport types and browsers see the
39493-
https://github.com/sockjs/sockjs-client[SockJS client] page. Transports
39494+
https://github.com/sockjs/sockjs-client/tree/v0.3.4[SockJS client] page. Transports
3949439495
fall in 3 general categories: WebSocket, HTTP Streaming, and HTTP Long Polling.
3949539496
For an overview of these categories see
3949639497
https://spring.io/blog/2012/05/08/spring-mvc-3-2-preview-techniques-for-real-time-updates/[this blog post].
@@ -39587,10 +39588,10 @@ integrate into other HTTP serving environments with the help of
3958739588
{javadoc-baseurl}/org/springframework/web/socket/sockjs/support/SockJsHttpRequestHandler.html[SockJsHttpRequestHandler].
3958839589

3958939590
On the browser side, applications can use the
39590-
https://github.com/sockjs/sockjs-client[sockjs-client] that emulates the W3C
39591-
WebSocket API and communicates with the server to select the best
39591+
https://github.com/sockjs/sockjs-client/tree/v0.3.4[sockjs-client] (version 0.3.x) that
39592+
emulates the W3C WebSocket API and communicates with the server to select the best
3959239593
transport option depending on the browser it's running in. Review the
39593-
https://github.com/sockjs/sockjs-client[sockjs-client] page and the list of
39594+
https://github.com/sockjs/sockjs-client/tree/v0.3.4[sockjs-client] page and the list of
3959439595
transport types supported by browser. The client also provides several
3959539596
configuration options, for example, to specify which transports to include.
3959639597

@@ -39672,7 +39673,7 @@ similar option on the `<websocket:sockjs>` element:
3967239673
During initial development, do enable the SockJS client `devel` mode that prevents
3967339674
the browser from caching SockJS requests (like the iframe) that would otherwise
3967439675
be cached. For details on how to enable it see the
39675-
https://github.com/sockjs/sockjs-client[SockJS client] page.
39676+
https://github.com/sockjs/sockjs-client/tree/v0.3.4[SockJS client] page.
3967639677
====
3967739678

3967839679
[[websocket-fallback-sockjs-heartbeat]]

0 commit comments

Comments
 (0)