Top Description Fields Constructors Methods
reactor.netty.http.websocket

public Class WebsocketSpecImpl

extends Object
implements WebsocketSpec
Class Inheritance
All Implemented Interfaces
reactor.netty.http.websocket.WebsocketSpec
Known Direct Subclasses
reactor.netty.http.client.WebsocketClientSpecImpl, reactor.netty.http.server.WebsocketServerSpecImpl
Imports
reactor.util.annotation.Nullable
Configurer implementation for WebsocketSpec.
Authors
Dmitrii Borin, Violeta Georgieva
Since
0.9.5

Field Summary

Modifier and TypeField and Description
private final boolean
compress

private final int
maxFramePayloadLength

private final String
protocols

private final boolean
proxyPing

Constructor Summary

AccessConstructor and Description
protected
WebsocketSpecImpl(WebsocketSpec.Builder<?> builder)

Method Summary

Modifier and TypeMethod and Description
public boolean
compress()

Implements reactor.netty.http.websocket.WebsocketSpec.compress.

Returns whether the websocket compression extension is enabled.
public final boolean
handlePing()

Implements reactor.netty.http.websocket.WebsocketSpec.handlePing.

Returns whether to proxy websocket PING frames or respond to them.
public final int
maxFramePayloadLength()

Implements reactor.netty.http.websocket.WebsocketSpec.maxFramePayloadLength.

Returns the configured maximum allowable frame payload length.
public final String
protocols()

Implements reactor.netty.http.websocket.WebsocketSpec.protocols.

Returns the configured sub protocols.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compressback to summary
private final boolean compress
maxFramePayloadLengthback to summary
private final int maxFramePayloadLength
protocolsback to summary
private final String protocols
proxyPingback to summary
private final boolean proxyPing

Constructor Detail

WebsocketSpecImplback to summary
protected WebsocketSpecImpl(WebsocketSpec.Builder<?> builder)

Method Detail

compressback to summary
public boolean compress()

Implements reactor.netty.http.websocket.WebsocketSpec.compress.

Doc from reactor.netty.http.websocket.WebsocketSpec.compress.

Returns whether the websocket compression extension is enabled.

Returns:boolean

returns whether the websocket compression extension is enabled.

Annotations
@Override
handlePingback to summary
public final boolean handlePing()

Implements reactor.netty.http.websocket.WebsocketSpec.handlePing.

Doc from reactor.netty.http.websocket.WebsocketSpec.handlePing.

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

Returns:boolean

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

Annotations
@Override
maxFramePayloadLengthback to summary
public final int maxFramePayloadLength()

Implements reactor.netty.http.websocket.WebsocketSpec.maxFramePayloadLength.

Doc from reactor.netty.http.websocket.WebsocketSpec.maxFramePayloadLength.

Returns the configured maximum allowable frame payload length.

Returns:int

returns the configured maximum allowable frame payload length.

Annotations
@Override
protocolsback to summary
public final String protocols()

Implements reactor.netty.http.websocket.WebsocketSpec.protocols.

Doc from reactor.netty.http.websocket.WebsocketSpec.protocols.

Returns the configured sub protocols.

Returns:String

returns the configured sub protocols.

Annotations
@Override
@Nullable