jetty.project/jetty-websocket
Lachlan f23236b09d
Merge pull request #4775 from eclipse/jetty-10.0.x-4771-WebSocketMessageHandlerTests
Issue #4771 - cleanup and add tests for the unused ws message handlers
2020-04-20 08:43:39 +10:00
..
websocket-core Merge pull request #4702 from eclipse/jetty-10.0.x-4603-WS_HTTP2_NPE 2020-03-27 09:44:24 +11:00
websocket-javax-client Merge branch jetty-10.0.x into jetty-10.0.x-WebSocket-JPMS 2020-03-17 11:07:29 +11:00
websocket-javax-common Issue #4691 - changes from review 2020-03-24 14:30:02 +11:00
websocket-javax-server Issue #4685 - Declare <scope> for jetty-slf4j-impl everywhere 2020-03-20 11:12:08 -05:00
websocket-javax-tests Merge pull request #4775 from eclipse/jetty-10.0.x-4771-WebSocketMessageHandlerTests 2020-04-20 08:43:39 +10:00
websocket-jetty-api Issue #4771 - cleanup and add tests for the different ws message handlers 2020-04-15 10:50:27 +10:00
websocket-jetty-client Issue #4685 - Declare <scope> for jetty-slf4j-impl everywhere 2020-03-20 11:12:08 -05:00
websocket-jetty-common Issue #4771 - cleanup and add tests for the different ws message handlers 2020-04-15 10:50:27 +10:00
websocket-jetty-server Jetty 10.0.x use HandlerList instead of HandlerCollection (#4757) 2020-04-15 18:42:28 +02:00
websocket-jetty-tests Merge pull request #4775 from eclipse/jetty-10.0.x-4771-WebSocketMessageHandlerTests 2020-04-20 08:43:39 +10:00
websocket-servlet Issue #4685 - Declare <scope> for jetty-slf4j-impl everywhere 2020-03-20 11:12:08 -05:00
websocket-util Issue #4771 - cleanup and add tests for the different ws message handlers 2020-04-15 10:50:27 +10:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml Issue #4548 - clean up websocket removing duplicated and unused classes (#4549) 2020-02-18 21:43:54 +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.