Top Description Inners Fields Constructors Methods

io.netty.handler.codec.http.websocketx

public final Class WebSocketServerProtocolConfig

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.websocketx.WebSocketServerProtocolConfig

Imports

io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandler.ClientHandshakeStateEvent, io.netty.util.internal.ObjectUtil

WebSocket server configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebSocketServerProtocolConfig.Builder

Field Summary

Modifier and Type	Field and Description
private final boolean	checkStartsWith
private final WebSocketDecoderConfig	decoderConfig
pack-priv static final long	DEFAULT_HANDSHAKE_TIMEOUT_MILLIS
private final boolean	dropPongFrames
private final long	forceCloseTimeoutMillis
private final boolean	handleCloseFrames
private final long	handshakeTimeoutMillis
private final WebSocketCloseStatus	sendCloseFrame
private final String	subprotocols
private final String	websocketPath

Constructor Summary

Access	Constructor and Description
private	WebSocketServerProtocolConfig(String websocketPath, String subprotocols, boolean checkStartsWith, long handshakeTimeoutMillis, long forceCloseTimeoutMillis, boolean handleCloseFrames, WebSocketCloseStatus sendCloseFrame, boolean dropPongFrames, WebSocketDecoderConfig decoderConfig)

Method Summary

Modifier and Type	Method and Description
public boolean	checkStartsWith()
public WebSocketDecoderConfig	decoderConfig()
public boolean	dropPongFrames()
public long	forceCloseTimeoutMillis()
public boolean	handleCloseFrames()
public long	handshakeTimeoutMillis()
public static WebSocketServerProtocolConfig.Builder	newBuilder()
public WebSocketCloseStatus	sendCloseFrame()
public String	subprotocols()
public WebSocketServerProtocolConfig.Builder	toBuilder()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	websocketPath()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

checkStartsWith	back to summary
private final boolean checkStartsWith

decoderConfig	back to summary
private final WebSocketDecoderConfig decoderConfig

DEFAULT_HANDSHAKE_TIMEOUT_MILLIS	back to summary
pack-priv static final long DEFAULT_HANDSHAKE_TIMEOUT_MILLIS

dropPongFrames	back to summary
private final boolean dropPongFrames

forceCloseTimeoutMillis	back to summary
private final long forceCloseTimeoutMillis

handleCloseFrames	back to summary
private final boolean handleCloseFrames

handshakeTimeoutMillis	back to summary
private final long handshakeTimeoutMillis

sendCloseFrame	back to summary
private final WebSocketCloseStatus sendCloseFrame

subprotocols	back to summary
private final String subprotocols

websocketPath	back to summary
private final String websocketPath

Constructor Detail

WebSocketServerProtocolConfig	back to summary
private WebSocketServerProtocolConfig(String websocketPath, String subprotocols, boolean checkStartsWith, long handshakeTimeoutMillis, long forceCloseTimeoutMillis, boolean handleCloseFrames, WebSocketCloseStatus sendCloseFrame, boolean dropPongFrames, WebSocketDecoderConfig decoderConfig)

Method Detail

checkStartsWith	back to summary
public boolean checkStartsWith()

decoderConfig	back to summary
public WebSocketDecoderConfig decoderConfig()

dropPongFrames	back to summary
public boolean dropPongFrames()

forceCloseTimeoutMillis	back to summary
public long forceCloseTimeoutMillis()

handleCloseFrames	back to summary
public boolean handleCloseFrames()

handshakeTimeoutMillis	back to summary
public long handshakeTimeoutMillis()

newBuilder	back to summary
public static WebSocketServerProtocolConfig.Builder newBuilder()

sendCloseFrame	back to summary
public WebSocketCloseStatus sendCloseFrame()

subprotocols	back to summary
public String subprotocols()

toBuilder	back to summary
public WebSocketServerProtocolConfig.Builder toBuilder()

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

websocketPath	back to summary
public String websocketPath()

io.netty.handler.codec.http.websocketx back to summary

public final Class WebSocketServerProtocolConfig.Builder

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http.websocketx.WebSocketServerProtocolConfig.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	checkStartsWith
private WebSocketDecoderConfig	decoderConfig
private WebSocketDecoderConfig.Builder	decoderConfigBuilder
private boolean	dropPongFrames
private long	forceCloseTimeoutMillis
private boolean	handleCloseFrames
private long	handshakeTimeoutMillis
private WebSocketCloseStatus	sendCloseFrame
private String	subprotocols
private String	websocketPath

Constructor Summary

Access	Constructor and Description
private	Builder(WebSocketServerProtocolConfig serverConfig)
private	Builder(String websocketPath, String subprotocols, boolean checkStartsWith, long handshakeTimeoutMillis, long forceCloseTimeoutMillis, boolean handleCloseFrames, WebSocketCloseStatus sendCloseFrame, boolean dropPongFrames, WebSocketDecoderConfig decoderConfig)

Method Summary

Modifier and Type	Method and Description
public WebSocketServerProtocolConfig.Builder	allowExtensions(boolean allowExtensions)
public WebSocketServerProtocolConfig.Builder	allowMaskMismatch(boolean allowMaskMismatch)
public WebSocketServerProtocolConfig	build() Build unmodifiable server protocol configuration.
public WebSocketServerProtocolConfig.Builder	checkStartsWith(boolean checkStartsWith) `true` to handle all requests, where URI path component starts from `WebSocketServerProtocolConfig#websocketPath()`, `false` for exact match (default).
public WebSocketServerProtocolConfig.Builder	closeOnProtocolViolation(boolean closeOnProtocolViolation)
public WebSocketServerProtocolConfig.Builder	decoderConfig(WebSocketDecoderConfig decoderConfig) Frames decoder configuration.
private WebSocketDecoderConfig.Builder	decoderConfigBuilder()
public WebSocketServerProtocolConfig.Builder	dropPongFrames(boolean dropPongFrames) `true` if pong frames should not be forwarded
public WebSocketServerProtocolConfig.Builder	expectMaskedFrames(boolean expectMaskedFrames)
public WebSocketServerProtocolConfig.Builder	forceCloseTimeoutMillis(long forceCloseTimeoutMillis) Close the connection if it was not closed by the client after timeout specified
public WebSocketServerProtocolConfig.Builder	handleCloseFrames(boolean handleCloseFrames) `true` if close frames should not be forwarded and just close the channel
public WebSocketServerProtocolConfig.Builder	handshakeTimeoutMillis(long handshakeTimeoutMillis) Handshake timeout in mills, when handshake timeout, will trigger user event `ClientHandshakeStateEvent#HANDSHAKE_TIMEOUT`
public WebSocketServerProtocolConfig.Builder	maxFramePayloadLength(int maxFramePayloadLength)
public WebSocketServerProtocolConfig.Builder	sendCloseFrame(WebSocketCloseStatus sendCloseFrame) Close frame to send, when close frame was not send manually.
public WebSocketServerProtocolConfig.Builder	subprotocols(String subprotocols) CSV of supported protocols
public WebSocketServerProtocolConfig.Builder	websocketPath(String websocketPath) URI path component to handle websocket upgrade requests on.
public WebSocketServerProtocolConfig.Builder	withUTF8Validator(boolean withUTF8Validator)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

checkStartsWith	back to summary
private boolean checkStartsWith

decoderConfig	back to summary
private WebSocketDecoderConfig decoderConfig

decoderConfigBuilder	back to summary
private WebSocketDecoderConfig.Builder decoderConfigBuilder

dropPongFrames	back to summary
private boolean dropPongFrames

forceCloseTimeoutMillis	back to summary
private long forceCloseTimeoutMillis

handleCloseFrames	back to summary
private boolean handleCloseFrames

handshakeTimeoutMillis	back to summary
private long handshakeTimeoutMillis

sendCloseFrame	back to summary
private WebSocketCloseStatus sendCloseFrame

subprotocols	back to summary
private String subprotocols

websocketPath	back to summary
private String websocketPath

Constructor Detail

Builder	back to summary
private Builder(WebSocketServerProtocolConfig serverConfig)

Builder	back to summary
private Builder(String websocketPath, String subprotocols, boolean checkStartsWith, long handshakeTimeoutMillis, long forceCloseTimeoutMillis, boolean handleCloseFrames, WebSocketCloseStatus sendCloseFrame, boolean dropPongFrames, WebSocketDecoderConfig decoderConfig)

Method Detail

allowExtensions	back to summary
public WebSocketServerProtocolConfig.Builder allowExtensions(boolean allowExtensions)

allowMaskMismatch	back to summary
public WebSocketServerProtocolConfig.Builder allowMaskMismatch(boolean allowMaskMismatch)

build	back to summary
public WebSocketServerProtocolConfig build() Build unmodifiable server protocol configuration.

checkStartsWith	back to summary
public WebSocketServerProtocolConfig.Builder checkStartsWith(boolean checkStartsWith) `true` to handle all requests, where URI path component starts from `WebSocketServerProtocolConfig#websocketPath()`, `false` for exact match (default).

closeOnProtocolViolation	back to summary
public WebSocketServerProtocolConfig.Builder closeOnProtocolViolation(boolean closeOnProtocolViolation)

decoderConfig	back to summary
public WebSocketServerProtocolConfig.Builder decoderConfig(WebSocketDecoderConfig decoderConfig) Frames decoder configuration.

decoderConfigBuilder	back to summary
private WebSocketDecoderConfig.Builder decoderConfigBuilder()

dropPongFrames	back to summary
public WebSocketServerProtocolConfig.Builder dropPongFrames(boolean dropPongFrames) `true` if pong frames should not be forwarded

expectMaskedFrames	back to summary
public WebSocketServerProtocolConfig.Builder expectMaskedFrames(boolean expectMaskedFrames)

forceCloseTimeoutMillis	back to summary
public WebSocketServerProtocolConfig.Builder forceCloseTimeoutMillis(long forceCloseTimeoutMillis) Close the connection if it was not closed by the client after timeout specified

handleCloseFrames	back to summary
public WebSocketServerProtocolConfig.Builder handleCloseFrames(boolean handleCloseFrames) `true` if close frames should not be forwarded and just close the channel

handshakeTimeoutMillis	back to summary
public WebSocketServerProtocolConfig.Builder handshakeTimeoutMillis(long handshakeTimeoutMillis) Handshake timeout in mills, when handshake timeout, will trigger user event `ClientHandshakeStateEvent#HANDSHAKE_TIMEOUT`

maxFramePayloadLength	back to summary
public WebSocketServerProtocolConfig.Builder maxFramePayloadLength(int maxFramePayloadLength)

sendCloseFrame	back to summary
public WebSocketServerProtocolConfig.Builder sendCloseFrame(WebSocketCloseStatus sendCloseFrame) Close frame to send, when close frame was not send manually. Or `null` to disable proper close.

subprotocols	back to summary
public WebSocketServerProtocolConfig.Builder subprotocols(String subprotocols) CSV of supported protocols

websocketPath	back to summary
public WebSocketServerProtocolConfig.Builder websocketPath(String websocketPath) URI path component to handle websocket upgrade requests on.

withUTF8Validator	back to summary
public WebSocketServerProtocolConfig.Builder withUTF8Validator(boolean withUTF8Validator)