jetty.project/jetty-websocket
Greg Wilkins 4dd80e9128 398467 Servlet 3.1 Non Blocking IO
More refinements to avoid duplicate code and optimise common paths
2013-05-14 17:52:46 +10:00
..
websocket-api 407469 - Method parameters for @OnWebSocketError should support Throwable 2013-05-08 11:27:51 -07:00
websocket-client Creating basic websocket-client examples 2013-05-08 14:18:23 -07:00
websocket-common [maven-release-plugin] prepare for next development iteration 2013-05-06 18:13:04 -05:00
websocket-server 398467 Servlet 3.1 Non Blocking IO 2013-05-14 17:52:46 +10:00
websocket-servlet Using subprotocols (its more websockety) in example instead 2013-05-08 12:31:48 -07:00
README.txt Get ready for 7.4 release 2011-04-01 03:42:09 +00:00
pom.xml [maven-release-plugin] prepare for next development iteration 2013-05-06 18:13:04 -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.