## Uses of Interface
org.eclipse.jetty.websocket.WebSocket

- Packages that use WebSocket
  Package | Description
  --- | ---
  org.eclipse.jetty.websocket |

- - ### Uses of WebSocket in org.eclipse.jetty.websocket

    Subinterfaces of WebSocket in org.eclipse.jetty.websocket
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `WebSocket.OnBinaryMessage` A nested WebSocket interface for receiving binary messages
    `static interface` | `WebSocket.OnControl` A nested WebSocket interface for receiving control messages
    `static interface` | `WebSocket.OnFrame` A nested WebSocket interface for receiving any websocket frame
    `static interface` | `WebSocket.OnTextMessage` A nested WebSocket interface for receiving text messages

    Methods in org.eclipse.jetty.websocket that return WebSocket
    Modifier and Type | Method and Description
    --- | ---
    `WebSocket` | WebSocketFactory.Acceptor.`doWebSocketConnect(javax.servlet.http.HttpServletRequest request, String protocol)` Factory method that applications needs to implement to return a `WebSocket` object.

    Methods in org.eclipse.jetty.websocket with parameters of type WebSocket
    Modifier and Type | Method and Description
    --- | ---
    `Future<WebSocket.Connection>` | WebSocketClient.`open(URI uri, WebSocket websocket)` Asynchronously opens a websocket connection and returns a `Future` to obtain the connection.
    `WebSocket.Connection` | WebSocketClient.`open(URI uri, WebSocket websocket, long maxConnectTime, TimeUnit units)` Opens a websocket connection to the URI and blocks until the connection is accepted or there is an error.
    `void` | WebSocketFactory.`upgrade(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, WebSocket websocket, String protocol)` Upgrade the request/response to a WebSocket Connection.

    Constructors in org.eclipse.jetty.websocket with parameters of type WebSocket
    Constructor and Description
    `WebSocketConnectionD00(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol)`
    `WebSocketConnectionD06(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol)`
    `WebSocketConnectionD08(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft)`
    `WebSocketConnectionD08(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft, MaskGen maskgen)`
    `WebSocketConnectionRFC6455(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft)`
    `WebSocketConnectionRFC6455(WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft, MaskGen maskgen)`
    `WebSocketServletConnectionD00(WebSocketFactory factory, WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol)`
    `WebSocketServletConnectionD06(WebSocketFactory factory, WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol)`
    `WebSocketServletConnectionD08(WebSocketFactory factory, WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft)`
    `WebSocketServletConnectionRFC6455(WebSocketFactory factory, WebSocket websocket, EndPoint endpoint, WebSocketBuffers buffers, long timestamp, int maxIdleTime, String protocol, List<Extension> extensions, int draft)`

Copyright © 1995-2012 Mort Bay Consulting. All Rights Reserved.