jetty.project/jetty-websocket
Lachlan Roberts 5d1d7c9c26 Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-09-10 10:55:34 +10:00
..
websocket-core-client Issue #4996 - Regularlize logging (#5167) 2020-08-24 17:15:13 +02:00
websocket-core-common Merge remote-tracking branch 'origin/jetty-9.4.x-4824-WSmaxOutgoingFrames' into jetty-10.0.x 2020-09-10 09:48:39 +10:00
websocket-core-server Merge remote-tracking branch 'origin/jetty-9.4.x-4824-WSmaxOutgoingFrames' into jetty-10.0.x 2020-09-10 09:48:39 +10:00
websocket-core-tests Issue #5170 - ensure bytes after 101 response isn't lost during upgrade 2020-08-31 18:29:28 +10:00
websocket-javax-client Updating to version 10.0.0-SNAPSHOT 2020-08-11 16:47:55 +08:00
websocket-javax-common Issue #4996 - Regularlize logging (#5167) 2020-08-24 17:15:13 +02:00
websocket-javax-server Issue #4996 - Regularlize logging (#5167) 2020-08-24 17:15:13 +02:00
websocket-javax-tests Disabled tests broken in Java 15 due to a JVM bug. 2020-09-02 18:52:10 +02:00
websocket-jetty-api Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-09-10 10:55:34 +10:00
websocket-jetty-client Merge branch 'jetty-10.0.x-4824-WSmaxOutgoingFrames' into jetty-10.0.x 2020-09-10 10:51:57 +10:00
websocket-jetty-common Merge branch 'jetty-10.0.x-4824-WSmaxOutgoingFrames' into jetty-10.0.x 2020-09-10 10:51:57 +10:00
websocket-jetty-server remove the extensions package as extensions are now written in websocket-core 2020-09-04 16:44:23 +10:00
websocket-jetty-tests Merge remote-tracking branch 'origin/jetty-9.4.x' into jetty-10.0.x 2020-09-10 10:55:34 +10:00
websocket-util Fix WebSocketServerExamplesTest to work with surefire update 2020-08-13 22:04:56 +10:00
websocket-util-server Merge remote-tracking branch 'origin/jetty-9.4.x-4824-WSmaxOutgoingFrames' into jetty-10.0.x 2020-09-10 09:48:39 +10:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml Updating to version 10.0.0-SNAPSHOT 2020-08-11 16:47:55 +08: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.