jetty.project/jetty-websocket
Lachlan Roberts 327783e1ce Merge remote-tracking branch 'eclipse/jetty-10.0.x' into jetty-10.0.x-3170-websocket-proxy
Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
2019-06-11 15:17:54 +10:00
..
javax-websocket-client Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356 Added tests for decoders 2019-05-29 17:43:19 +02:00
javax-websocket-common Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
javax-websocket-server Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
javax-websocket-tests Putting new JMH test in correct place (fix from last merge) 2019-06-10 10:04:30 -05:00
jetty-websocket-api Issue #3712 - rename maxIdleTime usage to idleTimeout for WebSockets 2019-06-05 14:18:47 +10:00
jetty-websocket-client Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
jetty-websocket-common Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
jetty-websocket-server Issue #3705 - WebSocket upgrade failure and CompletableFuture refactor 2019-06-06 08:13:33 +10:00
jetty-websocket-tests Issue #3712 - rename maxIdleTime usage to idleTimeout for WebSockets 2019-06-05 14:18:47 +10:00
websocket-common/src/main/java/org/eclipse/jetty/websocket/common Merge pull request #3637 from lachlan-roberts/jetty-9.4.x-3498-websocket-suspend 2019-06-04 13:42:24 +10:00
websocket-core Merge remote-tracking branch 'eclipse/jetty-10.0.x' into jetty-10.0.x-3170-websocket-proxy 2019-06-11 15:17:54 +10:00
websocket-servlet Issue #3712 - rename maxIdleTime usage to idleTimeout for WebSockets 2019-06-05 14:18:47 +10:00
README.TXT
pom.xml Updating to version 9.4.19-SNAPSHOT 2019-04-29 16:27:23 -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.