jetty.project/jetty-websocket
Joakim Erdfelt 3423375a97
Issue #5357 - Updating to https://eclipse.org/ (#5358)
* Issue #5357 - Updating to https://eclipse.org/

 - Removing redundant <url> refs in pom.xml
 - Correcting bad indenting from merge
 - Correcting mailing list references
 - Correcting bugs.eclipse.org references
 - Correcting text file references
 - Correcting html references
 - Correcting further references
 - Correcting download.eclipse.org reference
 - Adding test for demo-base /proxy/current/
 - Ensuring jetty-client is included in javadoc-proxy.war/WEB-INF/lib

Signed-off-by: Joakim Erdfelt <joakim.erdfelt@gmail.com>
2020-09-29 11:02:32 -05:00
..
javax-websocket-client-impl Issue #5122 - make number of active WS Sessions a managed attribute on SessionTracker 2020-08-06 20:45:06 +10:00
javax-websocket-server-impl Updating to version 9.4.32-SNAPSHOT 2020-07-23 13:53:47 -05:00
jetty-websocket-tests fix licence header and checkstyle 2020-09-23 10:34:50 +10:00
websocket-api reorder methods for maxOutgoingFrames, fix javadoc 2020-09-10 09:50:52 +10:00
websocket-client Issue #5170 - add testing to verify if this issue exists in 9.4.x 2020-09-22 18:23:55 +10:00
websocket-common reorder methods for maxOutgoingFrames, fix javadoc 2020-09-10 09:50:52 +10:00
websocket-server Issue #5121 - always use isDebugEnabled() check before debug logging in WebSocket (#5123) 2020-08-11 11:51:39 +02:00
websocket-servlet Updating to version 9.4.32-SNAPSHOT 2020-07-23 13:53:47 -05:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml Issue #5357 - Updating to https://eclipse.org/ (#5358) 2020-09-29 11:02:32 -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.