jetty.project/jetty-websocket
Lachlan 41a7b8d4e3
Merge pull request #4539 from eclipse/jetty-10.0.x-4501-SharedBlockingCallback
Issue #4501 - remove all SharedBlockingCallback usage from websocket
2020-02-05 10:07:12 +11:00
..
websocket-core Merge pull request #4489 from eclipse/jetty-10.0.x-2643-pkcs12_keystores 2020-01-30 19:28:49 +01:00
websocket-javax-client Fixes #4408 - fix issues with javax metadata and decoders (#4452) 2020-01-13 13:49:10 +11:00
websocket-javax-common Merge pull request #4539 from eclipse/jetty-10.0.x-4501-SharedBlockingCallback 2020-02-05 10:07:12 +11:00
websocket-javax-server Make the WebSocketServerContainer initialize methods private 2020-01-30 15:01:15 +11:00
websocket-javax-tests Merge pull request #4539 from eclipse/jetty-10.0.x-4501-SharedBlockingCallback 2020-02-05 10:07:12 +11:00
websocket-jetty-api Issue #3578 - Adopt EPL-2.0 for Jetty-10. 2020-01-09 20:10:19 +01:00
websocket-jetty-client Merge remote-tracking branch 'origin/jetty-10.0.x' into jetty-10.0.x-4450-WebSocketCoreJPMS 2020-01-22 14:51:51 +11:00
websocket-jetty-common Issue #4501 - remove all SharedBlockingCallback usage from websocket 2020-02-03 17:20:45 +11:00
websocket-jetty-server Make the WebSocketServerContainer initialize methods private 2020-01-30 15:01:15 +11:00
websocket-jetty-tests Merge pull request #4523 from eclipse/jetty-10.0.x-4502-wsOnClose 2020-01-30 09:10:48 +11:00
websocket-servlet Fixed compilation issues after merge. 2020-01-29 10:11:21 +01: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 9.4.26-SNAPSHOT 2019-12-20 11:30:41 -06: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.