jetty.project/jetty-websocket
Joakim Erdfelt 9b7b54ea0b 444517 - Ensure WebSocketUpgradeFilter is always first in filter chain
* Using Servlet 3.1's ServletContext.addFilter() mechanisms with its
    FilterRegistration to encourage the WebSocketUpgradeFilter to be
    first in the filter chain.
    Note: this is possible, but can be overridden by another call
    to the same ServletContext.addFilter() using the same techniques
    to put something in front of the WebSocketUpgradeFilter.
2014-09-18 11:11:31 -07:00
..
javax-websocket-client-impl Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07:00
javax-websocket-server-impl 444517 - Ensure WebSocketUpgradeFilter is always first in filter chain 2014-09-18 11:11:31 -07:00
websocket-api Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07:00
websocket-client Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07:00
websocket-common Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07:00
websocket-server 444517 - Ensure WebSocketUpgradeFilter is always first in filter chain 2014-09-18 11:11:31 -07:00
websocket-servlet Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07:00
README.TXT renamed README.txt to README.TXT and updated contents 2013-08-29 00:32:36 +10:00
pom.xml Using 9.2.4-SNAPSHOT for branch 2014-09-11 06:10:44 -07: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.