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

Field Summary

Modifier and Type	Field and Description
private final boolean	allowExtensions
private final boolean	allowMaskMismatch
private final boolean	closeOnProtocolViolation
pack-priv static final WebSocketDecoderConfig	DEFAULT
private final boolean	expectMaskedFrames
private final int	maxFramePayloadLength
private final boolean	withUTF8Validator

Constructor Summary

Access	Constructor and Description
private	WebSocketDecoderConfig(int Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks. maxFramePayloadLength, boolean Web socket servers must set this to true processed incoming masked payload. Client implementations must set this to false. expectMaskedFrames, boolean Allows to loosen the masking requirement on received frames. When this is set to false then also frames which are not masked properly according to the standard will still be accepted. allowMaskMismatch, boolean Flag to allow reserved extension bits to be used or not allowExtensions, boolean Flag to send close frame immediately on any protocol violation.ion. closeOnProtocolViolation, boolean Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection. withUTF8Validator) Constructor

Access

Constructor and Description

private

WebSocketDecoderConfig(int

Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks.

maxFramePayloadLength, boolean

Web socket servers must set this to true processed incoming masked payload. Client implementations must set this to false.

expectMaskedFrames, boolean

Allows to loosen the masking requirement on received frames. When this is set to false then also frames which are not masked properly according to the standard will still be accepted.

allowMaskMismatch, boolean

Flag to allow reserved extension bits to be used or not

allowExtensions, boolean

Flag to send close frame immediately on any protocol violation.ion.

closeOnProtocolViolation, boolean

Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection.

withUTF8Validator)

Constructor

Method Summary

Modifier and Type	Method and Description
public boolean	allowExtensions()
public boolean	allowMaskMismatch()
public boolean	closeOnProtocolViolation()
public boolean	expectMaskedFrames()
public int	maxFramePayloadLength()
public static WebSocketDecoderConfig.Builder	newBuilder()
public WebSocketDecoderConfig.Builder	toBuilder()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public boolean	withUTF8Validator()

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

allowExtensions	back to summary
private final boolean allowExtensions

allowMaskMismatch	back to summary
private final boolean allowMaskMismatch

closeOnProtocolViolation	back to summary
private final boolean closeOnProtocolViolation

DEFAULT	back to summary
pack-priv static final WebSocketDecoderConfig DEFAULT

expectMaskedFrames	back to summary
private final boolean expectMaskedFrames

maxFramePayloadLength	back to summary
private final int maxFramePayloadLength

withUTF8Validator	back to summary
private final boolean withUTF8Validator

Constructor Detail

WebSocketDecoderConfig	back to summary
private WebSocketDecoderConfig(int maxFramePayloadLength, boolean expectMaskedFrames, boolean allowMaskMismatch, boolean allowExtensions, boolean closeOnProtocolViolation, boolean withUTF8Validator) Constructor Parameters maxFramePayloadLength:int Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks. expectMaskedFrames:boolean Web socket servers must set this to true processed incoming masked payload. Client implementations must set this to false. allowMaskMismatch:boolean Allows to loosen the masking requirement on received frames. When this is set to false then also frames which are not masked properly according to the standard will still be accepted. allowExtensions:boolean Flag to allow reserved extension bits to be used or not closeOnProtocolViolation:boolean Flag to send close frame immediately on any protocol violation.ion. withUTF8Validator:boolean Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection.

WebSocketDecoderConfig

back to summary

private WebSocketDecoderConfig(int maxFramePayloadLength, boolean expectMaskedFrames, boolean allowMaskMismatch, boolean allowExtensions, boolean closeOnProtocolViolation, boolean withUTF8Validator)

Constructor

Parameters

maxFramePayloadLength:int: Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks.
expectMaskedFrames:boolean: Web socket servers must set this to true processed incoming masked payload. Client implementations must set this to false.
allowMaskMismatch:boolean: Allows to loosen the masking requirement on received frames. When this is set to false then also frames which are not masked properly according to the standard will still be accepted.
allowExtensions:boolean: Flag to allow reserved extension bits to be used or not
closeOnProtocolViolation:boolean: Flag to send close frame immediately on any protocol violation.ion.
withUTF8Validator:boolean: Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection.

Method Detail

allowExtensions	back to summary
public boolean allowExtensions()

allowMaskMismatch	back to summary
public boolean allowMaskMismatch()

closeOnProtocolViolation	back to summary
public boolean closeOnProtocolViolation()

expectMaskedFrames	back to summary
public boolean expectMaskedFrames()

maxFramePayloadLength	back to summary
public int maxFramePayloadLength()

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

toBuilder	back to summary
public WebSocketDecoderConfig.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

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

withUTF8Validator	back to summary
public boolean withUTF8Validator()

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

public final Class WebSocketDecoderConfig.Builder

Class Inheritance

extends Object

java.lang.Object
io.netty5.handler.codec.http.websocketx.WebSocketDecoderConfig.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	allowExtensions
private boolean	allowMaskMismatch
private boolean	closeOnProtocolViolation
private boolean	expectMaskedFrames
private int	maxFramePayloadLength
private boolean	withUTF8Validator

Constructor Summary

Access	Constructor and Description
private	Builder(WebSocketDecoderConfig decoderConfig)

Method Summary

Modifier and Type	Method and Description
public WebSocketDecoderConfig.Builder	allowExtensions(boolean allowExtensions)
public WebSocketDecoderConfig.Builder	allowMaskMismatch(boolean allowMaskMismatch)
public WebSocketDecoderConfig	build()
public WebSocketDecoderConfig.Builder	closeOnProtocolViolation(boolean closeOnProtocolViolation)
public WebSocketDecoderConfig.Builder	expectMaskedFrames(boolean expectMaskedFrames)
public WebSocketDecoderConfig.Builder	maxFramePayloadLength(int maxFramePayloadLength)
public WebSocketDecoderConfig.Builder	withUTF8Validator(boolean withUTF8Validator)

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

Field Detail

allowExtensions	back to summary
private boolean allowExtensions

allowMaskMismatch	back to summary
private boolean allowMaskMismatch

closeOnProtocolViolation	back to summary
private boolean closeOnProtocolViolation

expectMaskedFrames	back to summary
private boolean expectMaskedFrames

maxFramePayloadLength	back to summary
private int maxFramePayloadLength

withUTF8Validator	back to summary
private boolean withUTF8Validator

Constructor Detail

Builder	back to summary
private Builder(WebSocketDecoderConfig decoderConfig)

Method Detail

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

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

build	back to summary
public WebSocketDecoderConfig build()

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

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

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

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

public final Class WebSocketDecoderConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class WebSocketDecoderConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail