jetty.project/jetty-websocket
Joakim Erdfelt a498107c42 Parameter identification refactor + Decoder and PathParam integration 2013-03-22 13:18:02 -07:00
..
javax-websocket-client-impl Parameter identification refactor + Decoder and PathParam integration 2013-03-22 13:18:02 -07:00
javax-websocket-server-impl Parameter identification refactor + Decoder and PathParam integration 2013-03-22 13:18:02 -07:00
src/test/java/org/eclipse/jetty/websocket Merge remote-tracking branch 'origin/jetty-8' 2013-02-26 12:50:30 +11:00
websocket-api 403380 - Introduce WebSocketTimeoutException to differentiate between EOF on write and Timeout 2013-03-22 13:18:02 -07:00
websocket-client Merge from [master] -> [javawebsocket-jsr] 2013-03-11 10:57:08 -07:00
websocket-common 403817 - Use of WebSocket Session.close() results in invalid status code 2013-03-22 13:18:02 -07:00
websocket-server reverting dispatched session open 2013-03-22 13:18:02 -07:00
websocket-servlet Merge from [master] -> [javawebsocket-jsr] 2013-03-11 10:57:08 -07:00
README.txt Get ready for 7.4 release 2011-04-01 03:42:09 +00:00
pom.xml Merge from [master] -> [javawebsocket-jsr] 2013-03-11 10:57:08 -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.