Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

Class WsProtocolProvider

java.lang.Object

io.helidon.webclient.websocket.WsProtocolProvider

All Implemented Interfaces:

ClientProtocolProvider<WsClient,WsClientProtocolConfig>

public class WsProtocolProvider
extends Object
implements ClientProtocolProvider<WsClient,WsClientProtocolConfig>

ServiceLoader provider implementation for WebSocket protocol. This supports method WebClient.client(io.helidon.webclient.spi.Protocol).

Constructor Summary

Constructors

Constructor	Description
WsProtocolProvider()	Public constructor required by ServiceLoader.

Method Summary

Modifier and Type	Method	Description
Class<WsClientProtocolConfig>	configType()	Type of the config object.
WsClientProtocolConfig	defaultConfig()	Default configuration of this protocol.
WsClient	protocol(WebClient client, WsClientProtocolConfig config)	Create a protocol client instance.
String	protocolId()	Protocol id for ALPN (protocol negotiation when using TLS).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WsProtocolProvider

public WsProtocolProvider()

Public constructor required by ServiceLoader.

Method Details

protocolId

public String protocolId()

Description copied from interface: ClientProtocolProvider

Protocol id for ALPN (protocol negotiation when using TLS).

Specified by:

protocolId in interface ClientProtocolProvider<WsClient,WsClientProtocolConfig>

Returns:

protocol id

configType

public Class<WsClientProtocolConfig> configType()

Description copied from interface: ClientProtocolProvider

Type of the config object.

Specified by:

configType in interface ClientProtocolProvider<WsClient,WsClientProtocolConfig>

Returns:

config type

defaultConfig

public WsClientProtocolConfig defaultConfig()

Description copied from interface: ClientProtocolProvider

Default configuration of this protocol.

Specified by:

defaultConfig in interface ClientProtocolProvider<WsClient,WsClientProtocolConfig>

Returns:

protocol configuration

protocol

public WsClient protocol(WebClient client,
 WsClientProtocolConfig config)

Description copied from interface: ClientProtocolProvider

Create a protocol client instance.

Specified by:

protocol in interface ClientProtocolProvider<WsClient,WsClientProtocolConfig>

Parameters:

client - webclient to use

config - configuration of the protocol

Returns:

a new protocol client