Module swim.ws

Package swim.ws

Class WsEngineSettings

java.lang.Object

swim.ws.WsEngineSettings

All Implemented Interfaces:

Debug

Direct Known Subclasses:

WsSettings

public class WsEngineSettings
extends Object
implements Debug

Field Summary

Fields

Modifier and Type	Field	Description
protected int	clientCompressionLevel
protected int	clientMaxWindowBits
protected boolean	clientNoContextTakeover
protected int	maxFrameSize
protected int	maxMessageSize
protected int	serverCompressionLevel
protected int	serverMaxWindowBits
protected boolean	serverNoContextTakeover

Constructor Summary

Constructors

Constructor	Description
WsEngineSettings(int maxFrameSize, int maxMessageSize, int serverCompressionLevel, int clientCompressionLevel, boolean serverNoContextTakeover, boolean clientNoContextTakeover, int serverMaxWindowBits, int clientMaxWindowBits)

Method Summary

Modifier and Type	Method	Description
FingerTrieSeq<WebSocketExtension>	acceptExtensions(FingerTrieSeq<WebSocketExtension> requestExtensions)
static WsEngineSettings	bestCompression()
boolean	canEqual(Object other)
int	clientCompressionLevel()
WsEngineSettings	clientCompressionLevel(int clientCompressionLevel)
int	clientMaxWindowBits()
WsEngineSettings	clientMaxWindowBits(int clientMaxWindowBits)
boolean	clientNoContextTakeover()
WsEngineSettings	clientNoContextTakeover(boolean clientNoContextTakeover)
WsEngineSettings	compressionLevel(int serverCompressionLevel, int clientCompressionLevel)
protected WsEngineSettings	copy(int maxFrameSize, int maxMessageSize, int serverCompressionLevel, int clientCompressionLevel, boolean serverNoContextTakeover, boolean clientNoContextTakeover, int serverMaxWindowBits, int clientMaxWindowBits)
<T> Output<T>	debug(Output<T> output)	Writes a developer readable, debug-formatted string representation of this object to output.
static WsEngineSettings	defaultCompression()
static Form<WsEngineSettings>	engineForm()
boolean	equals(Object other)
FingerTrieSeq<WebSocketExtension>	extensions()
static WsEngineSettings	fastestCompression()
WsRequest	handshakeRequest(Uri uri)
WsRequest	handshakeRequest(Uri uri, FingerTrieSeq<String> protocols)
WsRequest	handshakeRequest(Uri uri, FingerTrieSeq<String> protocols, FingerTrieSeq<HttpHeader> headers)
WsRequest	handshakeRequest(Uri uri, FingerTrieSeq<String> protocols, HttpHeader... headers)
WsRequest	handshakeRequest(Uri uri, HttpHeader... headers)
int	hashCode()
int	maxFrameSize()
WsEngineSettings	maxFrameSize(int maxFrameSize)
int	maxMessageSize()
WsEngineSettings	maxMessageSize(int maxMessageSize)
static WsEngineSettings	noCompression()
int	serverCompressionLevel()
WsEngineSettings	serverCompressionLevel(int serverCompressionLevel)
int	serverMaxWindowBits()
WsEngineSettings	serverMaxWindowBits(int serverMaxWindowBits)
boolean	serverNoContextTakeover()
WsEngineSettings	serverNoContextTakeover(boolean serverNoContextTakeover)
static WsEngineSettings	standard()
String	toString()
Value	toValue()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

maxFrameSize

protected final int maxFrameSize

maxMessageSize

protected final int maxMessageSize

serverCompressionLevel

protected final int serverCompressionLevel

clientCompressionLevel

protected final int clientCompressionLevel

serverNoContextTakeover

protected final boolean serverNoContextTakeover

clientNoContextTakeover

protected final boolean clientNoContextTakeover

serverMaxWindowBits

protected final int serverMaxWindowBits

clientMaxWindowBits

protected final int clientMaxWindowBits

Constructor Detail

WsEngineSettings

public WsEngineSettings(int maxFrameSize,
                        int maxMessageSize,
                        int serverCompressionLevel,
                        int clientCompressionLevel,
                        boolean serverNoContextTakeover,
                        boolean clientNoContextTakeover,
                        int serverMaxWindowBits,
                        int clientMaxWindowBits)

Method Detail

maxFrameSize

public final int maxFrameSize()

maxFrameSize

public WsEngineSettings maxFrameSize(int maxFrameSize)

maxMessageSize

public final int maxMessageSize()

maxMessageSize

public WsEngineSettings maxMessageSize(int maxMessageSize)

serverCompressionLevel

public final int serverCompressionLevel()

serverCompressionLevel

public WsEngineSettings serverCompressionLevel(int serverCompressionLevel)

clientCompressionLevel

public final int clientCompressionLevel()

clientCompressionLevel

public WsEngineSettings clientCompressionLevel(int clientCompressionLevel)

compressionLevel

public WsEngineSettings compressionLevel(int serverCompressionLevel,
                                         int clientCompressionLevel)

serverNoContextTakeover

public final boolean serverNoContextTakeover()

serverNoContextTakeover

public WsEngineSettings serverNoContextTakeover(boolean serverNoContextTakeover)

clientNoContextTakeover

public final boolean clientNoContextTakeover()

clientNoContextTakeover

public WsEngineSettings clientNoContextTakeover(boolean clientNoContextTakeover)

serverMaxWindowBits

public final int serverMaxWindowBits()

serverMaxWindowBits

public WsEngineSettings serverMaxWindowBits(int serverMaxWindowBits)

clientMaxWindowBits

public final int clientMaxWindowBits()

clientMaxWindowBits

public WsEngineSettings clientMaxWindowBits(int clientMaxWindowBits)

extensions

public FingerTrieSeq<WebSocketExtension> extensions()

acceptExtensions

public FingerTrieSeq<WebSocketExtension> acceptExtensions(FingerTrieSeq<WebSocketExtension> requestExtensions)

handshakeRequest

public WsRequest handshakeRequest(Uri uri,
                                  FingerTrieSeq<String> protocols,
                                  FingerTrieSeq<HttpHeader> headers)

handshakeRequest

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

handshakeRequest

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

handshakeRequest

public WsRequest handshakeRequest(Uri uri,
                                  HttpHeader... headers)

handshakeRequest

public WsRequest handshakeRequest(Uri uri)

toValue

public Value toValue()

copy

protected WsEngineSettings copy(int maxFrameSize,
                                int maxMessageSize,
                                int serverCompressionLevel,
                                int clientCompressionLevel,
                                boolean serverNoContextTakeover,
                                boolean clientNoContextTakeover,
                                int serverMaxWindowBits,
                                int clientMaxWindowBits)

canEqual

public boolean canEqual(Object other)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

debug

public <T> Output<T> debug(Output<T> output)

Description copied from interface: Debug

Writes a developer readable, debug-formatted string representation of this object to output.

Specified by:

debug in interface Debug

Returns:

the continuation of the output.

toString

public String toString()

Overrides:

toString in class Object

standard

public static WsEngineSettings standard()

noCompression

public static WsEngineSettings noCompression()

defaultCompression

public static WsEngineSettings defaultCompression()

fastestCompression

public static WsEngineSettings fastestCompression()

bestCompression

public static WsEngineSettings bestCompression()

engineForm

@Kind
public static Form<WsEngineSettings> engineForm()