Top Description Inners Methods
reactor.netty.http.client

public Interface WebsocketClientSpec

extends WebsocketSpec
Known Direct Implementers
reactor.netty.http.client.WebsocketClientSpecImpl
Imports
io.netty.handler.codec.http.websocketx.WebSocketVersion, io.netty.handler.codec.http.websocketx.extensions.compression.PerMessageDeflateClientExtensionHandshaker, reactor.netty.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.

public boolean

Returns:

whether the server is allowed to activate client_no_context_takeover
compressionAllowClientNoContext()

Returns whether the server is allowed to activate client_no_context_takeover.

public boolean

Returns:

whether the client needs to activate server_no_context_takeover
compressionRequestedServerNoContext()

Returns whether the client needs to activate server_no_context_takeover.

public WebSocketVersion

Returns:

returns the configured WebSocket version
version()

Returns the configured WebSocket version.

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

Method Detail

builderback to summary
public static WebsocketClientSpec.Builder builder()

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

Returns:WebsocketClientSpec.Builder

Builder

compressionAllowClientNoContextback to summary
public boolean compressionAllowClientNoContext()

Returns whether the server is allowed to activate client_no_context_takeover.

Returns:boolean

whether the server is allowed to activate client_no_context_takeover

Since
1.1.14
compressionRequestedServerNoContextback to summary
public boolean compressionRequestedServerNoContext()

Returns whether the client needs to activate server_no_context_takeover.

Returns:boolean

whether the client needs to activate server_no_context_takeover

Since
1.1.14
versionback to summary
public WebSocketVersion version()

Returns the configured WebSocket version.

Returns:WebSocketVersion

returns the configured WebSocket version

Since
1.0.3
reactor.netty.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 boolean
allowClientNoContext

pack-priv boolean
requestedServerNoContext

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
compressionAllowClientNoContext(boolean
allows the server to activate client_no_context_takeover
allowClientNoContext)

Allows the server to activate client_no_context_takeover Default to false.

public final WebsocketClientSpec.Builder

Returns:

this
compressionRequestedServerNoContext(boolean
indicates if the client needs to activate server_no_context_takeover if the server is compatible with
requestedServerNoContext)

Indicates if the client needs to activate server_no_context_takeover if the server is compatible with.

public final WebsocketClientSpec.Builder

Returns:

this
version(WebSocketVersion
WebSocket version to be used
version)

Sets websocket version to use.

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

Field Detail

allowClientNoContextback to summary
pack-priv boolean allowClientNoContext
requestedServerNoContextback to summary
pack-priv boolean requestedServerNoContext
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

compressionAllowClientNoContextback to summary
public final WebsocketClientSpec.Builder compressionAllowClientNoContext(boolean allowClientNoContext)

Allows the server to activate client_no_context_takeover Default to false.

Parameters
allowClientNoContext:boolean

allows the server to activate client_no_context_takeover

Returns:WebsocketClientSpec.Builder

this

Since
1.1.14
See Also
PerMessageDeflateClientExtensionHandshaker
compressionRequestedServerNoContextback to summary
public final WebsocketClientSpec.Builder compressionRequestedServerNoContext(boolean requestedServerNoContext)

Indicates if the client needs to activate server_no_context_takeover if the server is compatible with. Default to false.

Parameters
requestedServerNoContext:boolean

indicates if the client needs to activate server_no_context_takeover if the server is compatible with

Returns:WebsocketClientSpec.Builder

this

Since
1.1.14
See Also
PerMessageDeflateClientExtensionHandshaker
versionback to summary
public final WebsocketClientSpec.Builder version(WebSocketVersion version)

Sets websocket version to use. Set to io.netty.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