Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix WebSocket operations guide for Jetty 10 documentation. (#6161) 

* Include protocols-websocket.adoc in the Operations Guide documentation.
* Fix websocket header hierarchy in documentation.

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan 2021-04-14 01:24:44 +10:00 committed by GitHub
parent 1e3f3a3cbb
commit 8366dcf03e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
documentation/jetty-documentation/src/main/asciidoc/operations-guide/protocols/chapter.adoc
View File

@ -34,8 +34,11 @@ $ java -jar $JETTY_HOME/start.jar --list-modules=connector
include::protocols-http.adoc[]
include::protocols-https.adoc[]
include::protocols-http2.adoc[]
include::protocols-http2s.adoc[]
include::protocols-http2c.adoc[]
include::protocols-ssl.adoc[]
include::protocols-proxy.adoc[]
include::protocols-websocket.adoc[]
// TODO: old_docs/connectors/*.adoc

3
documentation/jetty-documentation/src/main/asciidoc/operations-guide/protocols/protocols-http2.adoc
View File

@ -143,6 +143,3 @@ microservice3 <--> jetty : HTTP/2
microservice2 <--> microservice3 : HTTP/2
microservice1 <--> microservice3 : HTTP/2
----
include::protocols-http2s.adoc[]
include::protocols-http2c.adoc[]

6
documentation/jetty-documentation/src/main/asciidoc/operations-guide/protocols/protocols-websocket.adoc
View File

@ -34,7 +34,7 @@ Allows a single stream of an HTTP/2 connection to be upgraded to WebSocket.
This allows one TCP connection to be shared by both protocols and extends HTTP/2's more efficient use of the network to WebSockets.
[[og-protocols-websocket-configure]]
==== Configuring WebSocket
===== Configuring WebSocket
Jetty provides two WebSocket implementations: one based on the Java WebSocket APIs defined by JSR 356, provided by module `websocket-javax`, and one based on Jetty specific WebSocket APIs, provided by module `websocket-jetty`.
The Jetty `websocket` module enables both implementations, but each implementation can be enabled independently.
@ -69,7 +69,7 @@ $ java -jar $JETTY_HOME/start.jar --add-modules=http,https,http2c,http2,websocke
----
[[og-protocols-websocket-disable]]
==== Selectively Disabling WebSocket
===== Selectively Disabling WebSocket
Enabling the WebSocket Jetty modules comes with a startup cost because Jetty must perform two steps:
@ -104,7 +104,7 @@ For a specific web application, you can disable step 2 for Java WebSocket suppor
Furthermore, for a specific web application, you can disable step 1 (and therefore also step 2) as described in the xref:og-annotations[annotations processing section].
[[og-protocols-websocket-webapp-client]]
==== Using WebSocket Client in WebApps
===== Using WebSocket Client in WebApps
Web applications may need to use a WebSocket client to communicate with third party WebSocket services.