Module swim.ws

Package swim.ws

Class WsRequest

java.lang.Object

swim.ws.WsRequest

public class WsRequest
extends Object

WebSocket handshake request.

Field Summary

Fields

Modifier and Type	Field	Description
protected FingerTrieSeq<WebSocketExtension>	extensions
protected HttpRequest<?>	httpRequest
protected SecWebSocketKeyHeader	key
protected FingerTrieSeq<String>	protocols

Constructor Summary

Constructors

Constructor	Description
WsRequest(HttpRequest<?> httpRequest, SecWebSocketKeyHeader key, FingerTrieSeq<String> protocols, FingerTrieSeq<WebSocketExtension> extensions)

Method Summary

Modifier and Type	Method	Description
WsResponse	accept(HttpResponse<?> httpResponse, WsEngineSettings settings)
WsResponse	accept(WsEngineSettings settings)
WsResponse	accept(WsEngineSettings settings, String protocol)
WsResponse	accept(WsEngineSettings settings, String protocol, FingerTrieSeq<HttpHeader> headers)
WsResponse	accept(WsEngineSettings settings, String protocol, HttpHeader... headers)
WsResponse	accept(WsEngineSettings settings, FingerTrieSeq<HttpHeader> headers)
WsResponse	accept(WsEngineSettings settings, HttpHeader... headers)
static WsRequest	create(HttpRequest<?> httpRequest)
static WsRequest	create(Uri uri)
static WsRequest	create(Uri uri, FingerTrieSeq<String> protocols)
static WsRequest	create(Uri uri, FingerTrieSeq<String> protocols, FingerTrieSeq<WebSocketExtension> extensions, FingerTrieSeq<HttpHeader> headers)
static WsRequest	create(Uri uri, FingerTrieSeq<String> protocols, HttpHeader... headers)
static WsRequest	create(Uri uri, HttpHeader... headers)
FingerTrieSeq<WebSocketExtension>	extensions()
HttpRequest<?>	httpRequest()
HttpResponse<?>	httpResponse()
HttpResponse<?>	httpResponse(String protocol)
HttpResponse<?>	httpResponse(String protocol, FingerTrieSeq<WebSocketExtension> extensions, FingerTrieSeq<HttpHeader> headers)
HttpResponse<?>	httpResponse(String protocol, HttpHeader... headers)
HttpResponse<?>	httpResponse(FingerTrieSeq<HttpHeader> headers)
HttpResponse<?>	httpResponse(HttpHeader... headers)
SecWebSocketKeyHeader	key()
FingerTrieSeq<String>	protocols()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpRequest

protected final HttpRequest<?> httpRequest

key

protected final SecWebSocketKeyHeader key

protocols

protected final FingerTrieSeq<String> protocols

extensions

protected final FingerTrieSeq<WebSocketExtension> extensions

Constructor Detail

WsRequest

public WsRequest(HttpRequest<?> httpRequest,
                 SecWebSocketKeyHeader key,
                 FingerTrieSeq<String> protocols,
                 FingerTrieSeq<WebSocketExtension> extensions)

Method Detail

httpRequest

public final HttpRequest<?> httpRequest()

key

public final SecWebSocketKeyHeader key()

protocols

public final FingerTrieSeq<String> protocols()

extensions

public final FingerTrieSeq<WebSocketExtension> extensions()

httpResponse

public HttpResponse<?> httpResponse(String protocol,
                                    FingerTrieSeq<WebSocketExtension> extensions,
                                    FingerTrieSeq<HttpHeader> headers)

httpResponse

public HttpResponse<?> httpResponse(String protocol,
                                    HttpHeader... headers)

httpResponse

public HttpResponse<?> httpResponse(String protocol)

httpResponse

public HttpResponse<?> httpResponse(FingerTrieSeq<HttpHeader> headers)

httpResponse

public HttpResponse<?> httpResponse(HttpHeader... headers)

httpResponse

public HttpResponse<?> httpResponse()

accept

public WsResponse accept(WsEngineSettings settings,
                         String protocol,
                         FingerTrieSeq<HttpHeader> headers)

accept

public WsResponse accept(WsEngineSettings settings,
                         String protocol,
                         HttpHeader... headers)

accept

public WsResponse accept(WsEngineSettings settings,
                         String protocol)

accept

public WsResponse accept(WsEngineSettings settings,
                         FingerTrieSeq<HttpHeader> headers)

accept

public WsResponse accept(WsEngineSettings settings,
                         HttpHeader... headers)

accept

public WsResponse accept(WsEngineSettings settings)

accept

public WsResponse accept(HttpResponse<?> httpResponse,
                         WsEngineSettings settings)

create

public static WsRequest create(Uri uri,
                               FingerTrieSeq<String> protocols,
                               FingerTrieSeq<WebSocketExtension> extensions,
                               FingerTrieSeq<HttpHeader> headers)

create

public static WsRequest create(Uri uri,
                               FingerTrieSeq<String> protocols,
                               HttpHeader... headers)

create

public static WsRequest create(Uri uri,
                               FingerTrieSeq<String> protocols)

create

public static WsRequest create(Uri uri,
                               HttpHeader... headers)

create

public static WsRequest create(Uri uri)

create

public static WsRequest create(HttpRequest<?> httpRequest)