Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

Interface WsClientProtocolConfig

All Superinterfaces:

NamedService, NamedService, ProtocolConfig, Prototype.Api, WsProtocolConfig

All Known Implementing Classes:

WsClientProtocolConfig.BuilderBase.WsClientProtocolConfigImpl

public interface WsClientProtocolConfig
extends Prototype.Api, WsProtocolConfig

WebSocket client protocol configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WsClientProtocolConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static WsClientProtocolConfig.Builder	builder(WsClientProtocolConfig instance)	Create a new fluent API builder from an existing instance.
static WsClientProtocolConfig	create()	Create a new instance with default values.
static WsClientProtocolConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static WsClientProtocolConfig	create(Config config)	Create a new instance from configuration.
default Size	maxFrameSize()	Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).
String	name()	Name of this protocol configuration.
List<String>	subProtocols()	WebSocket sub-protocols requested by the client.
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Methods inherited from interface io.helidon.websocket.WsProtocolConfig

maxBufferedMessageSize

Method Details

builder

static WsClientProtocolConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static WsClientProtocolConfig.Builder builder(WsClientProtocolConfig 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 WsClientProtocolConfig 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

@Deprecated
static WsClientProtocolConfig create(Config config)

Deprecated.

use create(io.helidon.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 WsClientProtocolConfig create()

Create a new instance with default values.

Returns:

a new instance

type

default String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Specified by:

type in interface NamedService

Returns:

type of this service

name

String name()

Name of this protocol configuration.

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

protocol configuration name

subProtocols

List<String> subProtocols()

WebSocket sub-protocols requested by the client.

Returns:

requested WebSocket sub-protocols

maxFrameSize

default Size maxFrameSize()

Maximum WebSocket frame payload size accepted by the client, from 1 B through Integer.MAX_VALUE bytes; the default is 1 MiB, replacing the earlier effectively unbounded behavior, and exceeding the configured limit causes the client to close the connection with status code 1009 (Message Too Big).

Returns:

maximum frame payload size