jetty.project/jetty-websocket
Lachlan 2e1c01ac8c
Merge pull request #4723 from eclipse/jetty-10.0.x-WebSocketServlet
Issue #4722 - remove websocket-servlet
2020-05-07 22:45:04 +10:00
..
websocket-core Jetty 10.0.x immutable meta data (#4777) 2020-04-28 13:36:44 +02:00
websocket-javax-client Merge remote-tracking branch 'origin/jetty-10.0.x' into jetty-10.0.x-LinkageErrorInvestigation 2020-04-29 22:52:33 +10:00
websocket-javax-common Issue #4800 - Revert MethodHandle changes & update DistributionTests 2020-04-29 22:52:26 +10:00
websocket-javax-server Merge pull request #4723 from eclipse/jetty-10.0.x-WebSocketServlet 2020-05-07 22:45:04 +10:00
websocket-javax-tests Merge pull request #4723 from eclipse/jetty-10.0.x-WebSocketServlet 2020-05-07 22:45:04 +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 Jetty 10.0.x immutable meta data (#4777) 2020-04-28 13:36:44 +02:00
websocket-jetty-common Issue #4800 - Revert MethodHandle changes & update DistributionTests 2020-04-29 22:52:26 +10:00
websocket-jetty-server Fix broken OSGI tests due to websocket-util-server 2020-05-01 01:35:19 +10:00
websocket-jetty-tests Merge remote-tracking branch 'origin/jetty-10.0.x' into jetty-10.0.x-WebSocketServlet 2020-04-23 13:53:10 +10:00
websocket-util Fix broken WebSocket UTF-8 continuation test 2020-05-01 13:01:40 +10:00
websocket-util-server Fix broken OSGI tests due to websocket-util-server 2020-05-01 01:35:19 +10:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml Issue #4722 - create new module websocket-util-server 2020-04-22 17:26:46 +10: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.