Interface WsProtocolConfig

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

WsClientProtocolConfig, io.helidon.webclient.websocket.WsClientProtocolConfigBlueprint, WsConfig, io.helidon.webserver.websocket.WsConfigBlueprint

All Known Implementing Classes:

WsClientProtocolConfig.BuilderBase.WsClientProtocolConfigImpl, WsConfig.BuilderBase.WsConfigImpl, WsProtocolConfig.BuilderBase.WsProtocolConfigImpl

public interface WsProtocolConfig
extends Prototype.Api

WebSocket protocol configuration available from a WsSession.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WsProtocolConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static WsProtocolConfig.Builder	builder(WsProtocolConfig instance)	Create a new fluent API builder from an existing instance.
static WsProtocolConfig	create()	Create a new instance with default values.
static WsProtocolConfig	create(Config config)	Create a new instance from configuration.
default Size	maxBufferedMessageSize()	Maximum size of a WebSocket message buffered for delivery to a listener.

Method Details

builder

static WsProtocolConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static WsProtocolConfig.Builder builder(WsProtocolConfig 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 WsProtocolConfig 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 WsProtocolConfig create()

Create a new instance with default values.

Returns:

a new instance

maxBufferedMessageSize

default Size maxBufferedMessageSize()

Maximum size of a WebSocket message buffered for delivery to a listener. Binary message size is measured in bytes. Text message size is approximated using the number of UTF-16 code units in each decoded string fragment, as reported by String.length(), and may be smaller than the UTF-8 payload size. This setting does not limit messages delivered to listeners as fragments, readers, or input streams. The value must be between 0 B and Integer.MAX_VALUE bytes, inclusive. A value of 0 B disables buffering of non-empty messages while allowing empty messages. Default is 1 MiB.

Returns:

maximum size of a buffered message