Top Description Inners Methods
reactor.netty.http.server

public Interface WebsocketServerSpec

extends WebsocketSpec
Known Direct Implementers
reactor.netty.http.server.WebsocketServerSpecImpl
Imports
io.netty.handler.codec.http.websocketx.extensions.compression.PerMessageDeflateServerExtensionHandshaker, reactor.netty.http.websocket.WebsocketSpec
Websocket server configuration.
Author
Violeta Georgieva
Since
0.9.5

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WebsocketServerSpec.Builder

Method Summary

Modifier and TypeMethod and Description
public static WebsocketServerSpec.Builder

Returns:

WebsocketServerSpec.Builder
builder()

Create builder with default properties.

public boolean

Returns:

whether the client is allowed to activate server_no_context_takeover
compressionAllowServerNoContext()

Returns whether the client is allowed to activate server_no_context_takeover.

public boolean

Returns:

whether the server prefers to activate client_no_context_takeover
compressionPreferredClientNoContext()

Returns whether the server prefers to activate client_no_context_takeover.

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

Method Detail

builderback to summary
public static WebsocketServerSpec.Builder builder()

Create builder with default properties.
protocols = null
maxFramePayloadLength = 65536
handlePing = false
compress = false
compressionAllowServerNoContext = false
compressionPreferredClientNoContext = false

Returns:WebsocketServerSpec.Builder

WebsocketServerSpec.Builder

compressionAllowServerNoContextback to summary
public boolean compressionAllowServerNoContext()

Returns whether the client is allowed to activate server_no_context_takeover.

Returns:boolean

whether the client is allowed to activate server_no_context_takeover

Since
1.1.14
compressionPreferredClientNoContextback to summary
public boolean compressionPreferredClientNoContext()

Returns whether the server prefers to activate client_no_context_takeover.

Returns:boolean

whether the server prefers to activate client_no_context_takeover

Since
1.1.14
reactor.netty.http.server back to summary

public final Class WebsocketServerSpec.Builder

extends WebsocketSpec.Builder<WebsocketServerSpec.Builder>
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv boolean
allowServerNoContext

pack-priv boolean
preferredClientNoContext

Constructor Summary

AccessConstructor and Description
private
Builder()

Method Summary

Modifier and TypeMethod and Description
public final WebsocketServerSpec

Returns:

builds new WebsocketServerSpec
build()

Builds new WebsocketServerSpec.

public final WebsocketServerSpec.Builder

Returns:

this
compressionAllowServerNoContext(boolean
allows the client to activate server_no_context_takeover
allowServerNoContext)

Allows the client to activate server_no_context_takeover.

public final WebsocketServerSpec.Builder

Returns:

this
compressionPreferredClientNoContext(boolean
indicates if the server prefers to activate client_no_context_takeover if client is compatible with
preferredClientNoContext)

Indicates if the server prefers to activate client_no_context_takeover if client is compatible with.

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

Field Detail

allowServerNoContextback to summary
pack-priv boolean allowServerNoContext
preferredClientNoContextback to summary
pack-priv boolean preferredClientNoContext

Constructor Detail

Builderback to summary
private Builder()

Method Detail

buildback to summary
public final WebsocketServerSpec build()

Builds new WebsocketServerSpec.

Returns:WebsocketServerSpec

builds new WebsocketServerSpec

compressionAllowServerNoContextback to summary
public final WebsocketServerSpec.Builder compressionAllowServerNoContext(boolean allowServerNoContext)

Allows the client to activate server_no_context_takeover. Default to false.

Parameters
allowServerNoContext:boolean

allows the client to activate server_no_context_takeover

Returns:WebsocketServerSpec.Builder

this

Since
1.1.14
See Also
PerMessageDeflateServerExtensionHandshaker
compressionPreferredClientNoContextback to summary
public final WebsocketServerSpec.Builder compressionPreferredClientNoContext(boolean preferredClientNoContext)

Indicates if the server prefers to activate client_no_context_takeover if client is compatible with. Default to false.

Parameters
preferredClientNoContext:boolean

indicates if the server prefers to activate client_no_context_takeover if client is compatible with

Returns:WebsocketServerSpec.Builder

this

Since
1.1.14
See Also
PerMessageDeflateServerExtensionHandshaker