Package reactor.netty.http.websocket

Class WebsocketSpecImpl

java.lang.Object

reactor.netty.http.websocket.WebsocketSpecImpl

All Implemented Interfaces:

WebsocketSpec

public class WebsocketSpecImpl
extends Object
implements WebsocketSpec

Configurer implementation for WebsocketSpec.

Since:

0.9.5

Author:

Dmitrii Borin, Violeta Georgieva

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.netty.http.websocket.WebsocketSpec

WebsocketSpec.Builder<SPEC extends WebsocketSpec.Builder<SPEC>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebsocketSpecImpl(WebsocketSpec.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	compress()	Returns whether the websocket compression extension is enabled.
final boolean	handlePing()	Returns whether to proxy websocket PING frames or respond to them.
final int	maxDecompressionBufferSize()	Returns the configured maximum allowed size, in bytes, of the buffer used to decompress a websocket message/frame when the compression extension is enabled.
final int	maxFramePayloadLength()	Returns the configured maximum allowable frame payload length.
final @Nullable String	protocols()	Returns the configured sub protocols.

Methods inherited from class java.lang.Object

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

Constructor Details

WebsocketSpecImpl

protected WebsocketSpecImpl(WebsocketSpec.Builder<?> builder)

Method Details

protocols

public final @Nullable String protocols()

Description copied from interface: WebsocketSpec

Returns the configured sub protocols.

Specified by:

protocols in interface WebsocketSpec

Returns:

returns the configured sub protocols.

maxFramePayloadLength

public final int maxFramePayloadLength()

Description copied from interface: WebsocketSpec

Returns the configured maximum allowable frame payload length.

Note: When a websocket compression extension is enabled, this setting is applied on the compressed data.

Specified by:

maxFramePayloadLength in interface WebsocketSpec

Returns:

returns the configured maximum allowable frame payload length.

handlePing

public final boolean handlePing()

Description copied from interface: WebsocketSpec

Returns whether to proxy websocket PING frames or respond to them.

Specified by:

handlePing in interface WebsocketSpec

Returns:

returns whether to proxy websocket PING frames or respond to them.

compress

public boolean compress()

Description copied from interface: WebsocketSpec

Returns whether the websocket compression extension is enabled.

Specified by:

compress in interface WebsocketSpec

Returns:

returns whether the websocket compression extension is enabled.

maxDecompressionBufferSize

public final int maxDecompressionBufferSize()

Description copied from interface: WebsocketSpec

Returns the configured maximum allowed size, in bytes, of the buffer used to decompress a websocket message/frame when the compression extension is enabled. 0 means the maximum size is not limited.

Note: This setting has no effect unless WebsocketSpec.compress() is enabled.

Specified by:

maxDecompressionBufferSize in interface WebsocketSpec

Returns:

the configured maximum allowed size of the decompression buffer, in bytes