Top Description Inners Methods
reactor.netty5.http.client

public Interface WebsocketClientSpec

extends WebsocketSpec
Known Direct Implementers
reactor.netty5.http.client.WebsocketClientSpecImpl
Imports
io.netty5.handler.codec.http.websocketx.WebSocketVersion, reactor.netty5.http.websocket.WebsocketSpec, java.util.Objects
Websocket client configuration
Author
Violeta Georgieva
Since
0.9.7

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WebsocketClientSpec.Builder

Method Summary

Modifier and TypeMethod and Description
public static WebsocketClientSpec.Builder

Returns:

Builder
builder()

Create builder with default properties: version = io.netty5.handler.codec.http.websocketx.WebSocketVersion#V13 protocols = null maxFramePayloadLength = 65536 handlePing = false compress = false

public WebSocketVersion

Returns:

returns the configured WebSocket version
version()

Returns the configured WebSocket version

Inherited from reactor.netty5.http.websocket.WebsocketSpec:
compresshandlePingmaxFramePayloadLengthprotocols

Method Detail

builderback to summary
public static WebsocketClientSpec.Builder builder()

Create builder with default properties:
version = io.netty5.handler.codec.http.websocketx.WebSocketVersion#V13
protocols = null
maxFramePayloadLength = 65536
handlePing = false
compress = false

Returns:WebsocketClientSpec.Builder

Builder

versionback to summary
public WebSocketVersion version()

Returns the configured WebSocket version

Returns:WebSocketVersion

returns the configured WebSocket version

Since
1.0.3
reactor.netty5.http.client back to summary

public final Class WebsocketClientSpec.Builder

extends WebsocketSpec.Builder<WebsocketClientSpec.Builder>
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv WebSocketVersion
version

Constructor Summary

AccessConstructor and Description
private
Builder()

Method Summary

Modifier and TypeMethod and Description
public final WebsocketClientSpec

Returns:

builds new WebsocketClientSpec
build()

Builds new WebsocketClientSpec

public final WebsocketClientSpec.Builder

Returns:

this
version(WebSocketVersion
WebSocket version to be used
version)

Sets websocket version to use.

Inherited from reactor.netty5.http.websocket.WebsocketSpec.Builder:
compressgethandlePingmaxFramePayloadLengthprotocols

Field Detail

versionback to summary
pack-priv WebSocketVersion version

Constructor Detail

Builderback to summary
private Builder()

Method Detail

buildback to summary
public final WebsocketClientSpec build()

Builds new WebsocketClientSpec

Returns:WebsocketClientSpec

builds new WebsocketClientSpec

versionback to summary
public final WebsocketClientSpec.Builder version(WebSocketVersion version)

Sets websocket version to use. Set to io.netty5.handler.codec.http.websocketx.WebSocketVersion#V13 by default

Parameters
version:WebSocketVersion

WebSocket version to be used

Returns:WebsocketClientSpec.Builder

this

Exceptions
NullPointerException:
if version is null
IllegalArgumentException:
if the version is unknown
Since
1.0.3