jetty.project/jetty-websocket
Lachlan 794d67c4d6
Merge pull request #5024 from eclipse/jetty-9.4.x-5018-ClientUpgradeRequestTimeout
Issue #5018 - add request timeout onto ClientUpgradeRequest
2020-07-08 16:36:07 +10:00
..
javax-websocket-client-impl Issue #1100 - ensure init and destroy are always called on JSR356 Encoders 2020-06-22 11:51:06 +10:00
javax-websocket-server-impl Issue #1100 - replicate issue where Encoder init and destroy never called 2020-06-22 11:21:46 +10:00
jetty-websocket-tests Issue #5018 - rename ClientUpgradeRequest timeout to setTimeout 2020-07-07 22:05:01 +10:00
websocket-api Updating to version 9.4.31-SNAPSHOT 2020-06-11 08:24:34 -05:00
websocket-client Issue #5018 - rename ClientUpgradeRequest timeout to setTimeout 2020-07-07 22:05:01 +10:00
websocket-common Fixes #4971 - Simplify Connection.upgradeFrom()/upgradeTo(). (#5008) 2020-07-06 22:45:03 +02:00
websocket-server Updating to version 9.4.31-SNAPSHOT 2020-06-11 08:24:34 -05:00
websocket-servlet Updating to version 9.4.31-SNAPSHOT 2020-06-11 08:24:34 -05: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.31-SNAPSHOT 2020-06-11 08:24:34 -05: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.