Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

Interface WsClientProtocolConfig

All Superinterfaces:

NamedService, NamedService, ProtocolConfig, Prototype.Api

All Known Implementing Classes:

WsClientProtocolConfig.BuilderBase.WsClientProtocolConfigImpl

public interface WsClientProtocolConfig
extends Prototype.Api

Configuration of an HTTP/1.1 client.

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.
String	name()	Name option.
List<String>	subProtocols()	SubProtocols option.
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

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 option.

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

the name option

subProtocols

List<String> subProtocols()

SubProtocols option.

Returns:

the subProtocols option