Interface WsConfig

All Superinterfaces:

NamedService, ProtocolConfig, Prototype.Api, WsProtocolConfig

All Known Implementing Classes:

WsConfig.BuilderBase.WsConfigImpl

public interface WsConfig
extends Prototype.Api, WsProtocolConfig

WebSocket protocol configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WsConfig.Builder	Fluent API builder for WsConfig.
static class	WsConfig.BuilderBase<BUILDER extends WsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends WsConfig>	Fluent API builder base for WsConfig.

Method Summary

Modifier and Type	Method	Description
static WsConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static WsConfig.Builder	builder(WsConfig instance)	Create a new fluent API builder from an existing instance.
static WsConfig	create()	Create a new instance with default values.
static WsConfig	create(Config config)	Create a new instance from configuration.
int	maxFrameLength()	Max WebSocket frame size supported by the server on a read operation.
String	name()	Name of this configuration.
Set<String>	origins()	WebSocket origins.
default String	type()	Protocol configuration type.

Methods inherited from interface ProtocolConfig

enabled, transportBindingTypes

Modifier and Type	Method	Description
default boolean	enabled()	Whether this protocol configuration is enabled.
default Set<String>	transportBindingTypes()	Transport binding provider keys compatible with this protocol.

Methods inherited from interface WsProtocolConfig

maxBufferedMessageSize

Modifier and Type	Method	Description
default Size	maxBufferedMessageSize()	Maximum size of a WebSocket message buffered for delivery to a listener.

Method Details

builder

static WsConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static WsConfig.Builder builder(WsConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static WsConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static WsConfig create()

Create a new instance with default values.

Returns:

a new instance

type

default String type()

Protocol configuration type.

Specified by:

type in interface NamedService

Returns:

type of this configuration

origins

Set<String> origins()

WebSocket origins. If this set is empty, requests with an Origin header must match the request Host header authority. If this set is non-empty, it acts as an explicit allowlist. Requests without an Origin header are allowed.

Returns:

origins

name

String name()

Name of this configuration.

Specified by:

name in interface NamedService

Returns:

configuration name

maxFrameLength

int maxFrameLength()

Max WebSocket frame size supported by the server on a read operation. Default is 1 MiB.

Returns:

max frame size to read