Module swim.io.ws

Package swim.io.ws

Class WsSettings

java.lang.Object

swim.ws.WsEngineSettings

swim.io.ws.WsSettings

All Implemented Interfaces:

Debug

public class WsSettings
extends WsEngineSettings

WebSocket configuration parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected HttpSettings	httpSettings

Fields inherited from class swim.ws.WsEngineSettings

clientCompressionLevel, clientMaxWindowBits, clientNoContextTakeover, maxFrameSize, maxMessageSize, serverCompressionLevel, serverMaxWindowBits, serverNoContextTakeover

Constructor Summary

Constructors

Constructor	Description
WsSettings(HttpSettings httpSettings, int maxFrameSize, int maxMessageSize, int serverCompressionLevel, int clientCompressionLevel, boolean serverNoContextTakeover, boolean clientNoContextTakeover, int serverMaxWindowBits, int clientMaxWindowBits)

Method Summary

Modifier and Type	Method	Description
static WsSettings	bestCompression()
boolean	canEqual(Object other)
WsSettings	clientCompressionLevel(int clientCompressionLevel)
WsSettings	clientMaxWindowBits(int clientMaxWindowBits)
WsSettings	clientNoContextTakeover(boolean clientNoContextTakeover)
WsSettings	compressionLevel(int serverCompressionLevel, int clientCompressionLevel)
protected WsSettings	copy(int maxFrameSize, int maxMessageSize, int serverCompressionLevel, int clientCompressionLevel, boolean serverNoContextTakeover, boolean clientNoContextTakeover, int serverMaxWindowBits, int clientMaxWindowBits)
protected WsSettings	copy(HttpSettings httpSettings, int maxFrameSize, int maxMessageSize, int serverCompressionLevel, int clientCompressionLevel, boolean serverNoContextTakeover, boolean clientNoContextTakeover, int serverMaxWindowBits, int clientMaxWindowBits)
void	debug(Output<?> output)	Writes a developer readable, debug-formatted string representation of this object to output.
static WsSettings	defaultCompression()
WsSettings	engineSettings(WsEngineSettings engineSettings)
boolean	equals(Object other)
static WsSettings	fastestCompression()
static Form<WsSettings>	form()
static WsSettings	from(HttpSettings httpSettings)
static WsSettings	from(IpSettings ipSettings)
static WsSettings	from(WsEngineSettings engineSettings)
int	hashCode()
HttpSettings	httpSettings()
WsSettings	httpSettings(HttpSettings httpSettings)
IpSettings	ipSettings()
WsSettings	ipSettings(IpSettings ipSettings)
WsSettings	maxFrameSize(int maxFrameSize)
WsSettings	maxMessageSize(int maxMessageSize)
static WsSettings	noCompression()
WsSettings	serverCompressionLevel(int serverCompressionLevel)
WsSettings	serverMaxWindowBits(int serverMaxWindowBits)
WsSettings	serverNoContextTakeover(boolean serverNoContextTakeover)
static WsSettings	standard()
TcpSettings	tcpSettings()
WsSettings	tcpSettings(TcpSettings tcpSettings)
TlsSettings	tlsSettings()
WsSettings	tlsSettings(TlsSettings tlsSettings)
Value	toValue()

Methods inherited from class swim.ws.WsEngineSettings

acceptExtensions, clientCompressionLevel, clientMaxWindowBits, clientNoContextTakeover, engineForm, extensions, handshakeRequest, handshakeRequest, handshakeRequest, handshakeRequest, handshakeRequest, maxFrameSize, maxMessageSize, serverCompressionLevel, serverMaxWindowBits, serverNoContextTakeover, toString

Methods inherited from class java.lang.Object

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

Field Detail

httpSettings

protected final HttpSettings httpSettings

Constructor Detail

WsSettings

public WsSettings(HttpSettings httpSettings,
                  int maxFrameSize,
                  int maxMessageSize,
                  int serverCompressionLevel,
                  int clientCompressionLevel,
                  boolean serverNoContextTakeover,
                  boolean clientNoContextTakeover,
                  int serverMaxWindowBits,
                  int clientMaxWindowBits)

Method Detail

httpSettings

public final HttpSettings httpSettings()

httpSettings

public WsSettings httpSettings(HttpSettings httpSettings)

ipSettings

public final IpSettings ipSettings()

ipSettings

public WsSettings ipSettings(IpSettings ipSettings)

tlsSettings

public final TlsSettings tlsSettings()

tlsSettings

public WsSettings tlsSettings(TlsSettings tlsSettings)

tcpSettings

public final TcpSettings tcpSettings()

tcpSettings

public WsSettings tcpSettings(TcpSettings tcpSettings)

engineSettings

public WsSettings engineSettings(WsEngineSettings engineSettings)

maxFrameSize

public WsSettings maxFrameSize(int maxFrameSize)

Overrides:

maxFrameSize in class WsEngineSettings

maxMessageSize

public WsSettings maxMessageSize(int maxMessageSize)

Overrides:

maxMessageSize in class WsEngineSettings

serverCompressionLevel

public WsSettings serverCompressionLevel(int serverCompressionLevel)

Overrides:

serverCompressionLevel in class WsEngineSettings

clientCompressionLevel

public WsSettings clientCompressionLevel(int clientCompressionLevel)

Overrides:

clientCompressionLevel in class WsEngineSettings

compressionLevel

public WsSettings compressionLevel(int serverCompressionLevel,
                                   int clientCompressionLevel)

Overrides:

compressionLevel in class WsEngineSettings

serverNoContextTakeover

public WsSettings serverNoContextTakeover(boolean serverNoContextTakeover)

Overrides:

serverNoContextTakeover in class WsEngineSettings

clientNoContextTakeover

public WsSettings clientNoContextTakeover(boolean clientNoContextTakeover)

Overrides:

clientNoContextTakeover in class WsEngineSettings

serverMaxWindowBits

public WsSettings serverMaxWindowBits(int serverMaxWindowBits)

Overrides:

serverMaxWindowBits in class WsEngineSettings

clientMaxWindowBits

public WsSettings clientMaxWindowBits(int clientMaxWindowBits)

Overrides:

clientMaxWindowBits in class WsEngineSettings

toValue

public Value toValue()

Overrides:

toValue in class WsEngineSettings

copy

protected WsSettings copy(HttpSettings httpSettings,
                          int maxFrameSize,
                          int maxMessageSize,
                          int serverCompressionLevel,
                          int clientCompressionLevel,
                          boolean serverNoContextTakeover,
                          boolean clientNoContextTakeover,
                          int serverMaxWindowBits,
                          int clientMaxWindowBits)

copy

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

Overrides:

copy in class WsEngineSettings

canEqual

public boolean canEqual(Object other)

Overrides:

canEqual in class WsEngineSettings

equals

public boolean equals(Object other)

Overrides:

equals in class WsEngineSettings

hashCode

public int hashCode()

Overrides:

hashCode in class WsEngineSettings

debug

public void debug(Output<?> 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

Overrides:

debug in class WsEngineSettings

standard

public static WsSettings standard()

noCompression

public static WsSettings noCompression()

defaultCompression

public static WsSettings defaultCompression()

fastestCompression

public static WsSettings fastestCompression()

bestCompression

public static WsSettings bestCompression()

from

public static WsSettings from(HttpSettings httpSettings)

from

public static WsSettings from(IpSettings ipSettings)

from

public static WsSettings from(WsEngineSettings engineSettings)

form

@Kind
public static Form<WsSettings> form()