jetty.project/jetty-websocket
Simone Bordet 1ac6b82912 428232 - Rework batch mode / buffering in websocket.
Introduced the automatic batch mode, akin to Jetty 8's WebSocket
implementation.
Now, if there are no more frames to process, and the previous frames
have been aggregated, FrameFlusher auto-flushes the aggregated frames.
This simplifies applications because they don't need to call flush()
explicitly.
2014-02-18 18:31:49 +01:00
..
javax-websocket-client-impl 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
javax-websocket-server-impl 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
websocket-api 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
websocket-client 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
websocket-common 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
websocket-server 428232 - Rework batch mode / buffering in websocket. 2014-02-18 18:31:49 +01:00
websocket-servlet set versions.txt file to new version and fix mistaken developmentVersion 2014-02-10 13:48:29 -06:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml set versions.txt file to new version and fix mistaken developmentVersion 2014-02-10 13:48:29 -06: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.