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 swim.collections.FingerTrieSeq<swim.http.WebSocketExtension>	extensions
protected swim.http.HttpRequest<?>	httpRequest
protected swim.http.header.SecWebSocketKey	key
protected swim.collections.FingerTrieSeq<String>	protocols

Constructor Summary

Constructors

Constructor	Description
WsRequest(swim.http.HttpRequest<?> httpRequest, swim.http.header.SecWebSocketKey key, swim.collections.FingerTrieSeq<String> protocols, swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions)

Method Summary

Modifier and Type	Method	Description
WsResponse	accept(swim.http.HttpResponse<?> httpResponse, WsEngineSettings settings)
WsResponse	accept(WsEngineSettings settings)
WsResponse	accept(WsEngineSettings settings, String protocol)
WsResponse	accept(WsEngineSettings settings, String protocol, swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)
WsResponse	accept(WsEngineSettings settings, String protocol, swim.http.HttpHeader... headers)
WsResponse	accept(WsEngineSettings settings, swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)
WsResponse	accept(WsEngineSettings settings, swim.http.HttpHeader... headers)
swim.collections.FingerTrieSeq<swim.http.WebSocketExtension>	extensions()
static WsRequest	from(swim.http.HttpRequest<?> httpRequest)
static WsRequest	from(swim.uri.Uri uri)
static WsRequest	from(swim.uri.Uri uri, swim.collections.FingerTrieSeq<String> protocols)
static WsRequest	from(swim.uri.Uri uri, swim.collections.FingerTrieSeq<String> protocols, swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions, swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)
static WsRequest	from(swim.uri.Uri uri, swim.collections.FingerTrieSeq<String> protocols, swim.http.HttpHeader... headers)
static WsRequest	from(swim.uri.Uri uri, swim.http.HttpHeader... headers)
swim.http.HttpRequest<?>	httpRequest()
swim.http.HttpResponse<?>	httpResponse()
swim.http.HttpResponse<?>	httpResponse(String protocol)
swim.http.HttpResponse<?>	httpResponse(String protocol, swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions, swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)
swim.http.HttpResponse<?>	httpResponse(String protocol, swim.http.HttpHeader... headers)
swim.http.HttpResponse<?>	httpResponse(swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)
swim.http.HttpResponse<?>	httpResponse(swim.http.HttpHeader... headers)
swim.http.header.SecWebSocketKey	key()
swim.collections.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 swim.http.HttpRequest<?> httpRequest

key

protected final swim.http.header.SecWebSocketKey key

protocols

protected final swim.collections.FingerTrieSeq<String> protocols

extensions

protected final swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions

Constructor Detail

WsRequest

public WsRequest(swim.http.HttpRequest<?> httpRequest,
                 swim.http.header.SecWebSocketKey key,
                 swim.collections.FingerTrieSeq<String> protocols,
                 swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions)

Method Detail

httpRequest

public final swim.http.HttpRequest<?> httpRequest()

key

public final swim.http.header.SecWebSocketKey key()

protocols

public final swim.collections.FingerTrieSeq<String> protocols()

extensions

public final swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions()

httpResponse

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

httpResponse

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

httpResponse

public swim.http.HttpResponse<?> httpResponse(String protocol)

httpResponse

public swim.http.HttpResponse<?> httpResponse(swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)

httpResponse

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

httpResponse

public swim.http.HttpResponse<?> httpResponse()

accept

public WsResponse accept(WsEngineSettings settings,
                         String protocol,
                         swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)

accept

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

accept

public WsResponse accept(WsEngineSettings settings,
                         String protocol)

accept

public WsResponse accept(WsEngineSettings settings,
                         swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)

accept

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

accept

public WsResponse accept(WsEngineSettings settings)

accept

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

from

public static WsRequest from(swim.uri.Uri uri,
                             swim.collections.FingerTrieSeq<String> protocols,
                             swim.collections.FingerTrieSeq<swim.http.WebSocketExtension> extensions,
                             swim.collections.FingerTrieSeq<swim.http.HttpHeader> headers)

from

public static WsRequest from(swim.uri.Uri uri,
                             swim.collections.FingerTrieSeq<String> protocols,
                             swim.http.HttpHeader... headers)

from

public static WsRequest from(swim.uri.Uri uri,
                             swim.collections.FingerTrieSeq<String> protocols)

from

public static WsRequest from(swim.uri.Uri uri,
                             swim.http.HttpHeader... headers)

from

public static WsRequest from(swim.uri.Uri uri)

from

public static WsRequest from(swim.http.HttpRequest<?> httpRequest)