jetty.project/jetty-websocket
Simone Bordet b9f89af847 Fixes #3320 - Review Jetty 10 module-info.java.
Reviewed module-info.java files.
For those that have a "requires static" added a comment about
why the dependency is optional.
Rearranged directives in alphabetical order.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
2019-02-08 17:30:27 +01:00
..
javax-websocket-client Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
javax-websocket-common Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
javax-websocket-server Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
javax-websocket-tests Merge remote-tracking branch 'eclipse/jetty-10.0.x' into jetty-10.0.x-3298-completableFutures 2019-01-30 15:00:01 +11:00
jetty-websocket-api Issue #3162 - Use Jetty specific Servlet API jar. 2019-02-04 18:51:51 +01:00
jetty-websocket-client Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
jetty-websocket-common Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
jetty-websocket-server Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
jetty-websocket-tests Merged branch 'jetty-10.0.x' into 'jetty-10.0.x-3162_jetty_servlet_api'. 2019-02-04 23:11:32 +01:00
websocket-core Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
websocket-servlet Fixes #3320 - Review Jetty 10 module-info.java. 2019-02-08 17:30:27 +01:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml rename websocket-tests module to jetty-websocket-tests 2019-01-29 10:29:38 +11: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.