jetty.project/jetty-websocket
Lachlan Roberts 1be0220988 Issue #4919 - make the SessionTracker the one to implement Graceful shutdown
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
2020-07-28 17:38:41 +10:00
..
websocket-core-client Issue #5018 - fix merge to jetty-10, WSClient.connect Future should fail upgrade 2020-07-23 11:17:05 +10:00
websocket-core-common Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-07-20 12:01:53 +02:00
websocket-core-server Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-07-16 08:46:29 +10:00
websocket-core-tests Issue #4808 - Review HttpClient Request header APIs. 2020-07-13 16:44:07 +02:00
websocket-javax-client Issue #4919 - all websocket containers to implement Graceful shutdown interface 2020-07-23 00:09:43 +10:00
websocket-javax-common Issue #4919 - make the SessionTracker the one to implement Graceful shutdown 2020-07-28 17:38:41 +10:00
websocket-javax-server Issue #4919 - all websocket containers to implement Graceful shutdown interface 2020-07-23 00:09:43 +10:00
websocket-javax-tests Merge remote-tracking branch 'origin/jetty-10.0.x' into jetty-10.0.x-4919-WebSocketContainerStop 2020-07-24 13:39:07 +10:00
websocket-jetty-api Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-07-23 10:19:53 +10:00
websocket-jetty-client Issue #4919 - make the SessionTracker the one to implement Graceful shutdown 2020-07-28 17:38:41 +10:00
websocket-jetty-common Issue #4919 - make the SessionTracker the one to implement Graceful shutdown 2020-07-28 17:38:41 +10:00
websocket-jetty-server Issue #4919 - make the SessionTracker the one to implement Graceful shutdown 2020-07-28 17:38:41 +10:00
websocket-jetty-tests Merge remote-tracking branch 'origin/jetty-10.0.x' into jetty-10.0.x-4919-WebSocketContainerStop 2020-07-24 13:39:07 +10:00
websocket-util Issue #4919 - make the SessionTracker the one to implement Graceful shutdown 2020-07-28 17:38:41 +10:00
websocket-util-server revert fail release 2020-07-10 15:04:22 +10:00
README.TXT
pom.xml revert fail release 2020-07-10 15:04:22 +10:00

README.TXT


This is the jetty websocket module that provides a websocket server and the skeleton of a websocket client.

By default websockets is included with a jetty release (with these classes either being in the jetty-websocket jar or in
an aggregate jar (see below).


In order to accept a websocket connection, the websocket handshake request is first routed to normal HTTP request
handling, which must respond with a 101 response and an instance of WebSocketConnection set as the
"org.eclipse.jetty.io.Connection" request attribute.   The accepting behaviour is provided by WebSocketHandler or the
WebSocketServlet class, both of which delegate to the WebSocketFactory class.

A TestServer and TestClient class are available, and can be run either directly from an IDE (if jetty source is
imported), or from the command line with


  java -cp jetty-aggregate/jetty-all/target/jetty-all-7.x.y.jar:jetty-distribution/target/distribution/lib/servlet-api-2.5.jar
  org.eclipse.jetty.websocket.TestServer  --help 

  java -cp jetty-aggregate/jetty-all/target/jetty-all-7.x.y.jar:jetty-distribution/target/distribution/lib/servlet-api-2.5.jar
  org.eclipse.jetty.websocket.TestClient --help


Without a protocol specified, the client will just send/receive websocket PING/PONG packets.    A protocol can be specified for testing other
aspects of websocket.  Specifically the server and client understand the following protocols:

    org.ietf.websocket.test-echo
        Websocket messages are sent by the client and the server will echo every frame.

    org.ietf.websocket.test-echo-broadcast
        Websocket messages are sent by the client and the server will echo every frame to every connection.

    org.ietf.websocket.test-echo-assemble
        Websocket messages are sent by the client and the server will echo assembled messages as a single frame.

    org.ietf.websocket.test-echo-fragment
        Websocket messages are sent and the server will echo each message fragmented into 2 frames.