Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Class WebSocket13FrameDecoder

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.ByteToMessageDecoder

io.netty5.handler.codec.http.websocketx.WebSocket13FrameDecoder

All Implemented Interfaces:

ChannelHandler, WebSocketFrameDecoder

public class WebSocket13FrameDecoder
extends ByteToMessageDecoder
implements WebSocketFrameDecoder

Decodes a web socket frame from wire protocol version 13 format. V13 is essentially the same as V8.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty5.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Field Summary

Fields inherited from class io.netty5.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
WebSocket13FrameDecoder(boolean expectMaskedFrames, boolean allowExtensions, int maxFramePayloadLength)	Constructor
WebSocket13FrameDecoder(boolean expectMaskedFrames, boolean allowExtensions, int maxFramePayloadLength, boolean allowMaskMismatch)	Constructor
WebSocket13FrameDecoder(WebSocketDecoderConfig decoderConfig)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	checkCloseFrameBody(ChannelHandlerContext ctx, Buffer buffer)
protected void	decode(ChannelHandlerContext ctx, Buffer in)	Decode the from one Buffer to another.

Methods inherited from class io.netty5.handler.codec.ByteToMessageDecoder

actualReadableBytes, channelInactive, channelRead, channelReadComplete, channelShutdown, decodeLast, discardSomeReadBytes, handlerAdded, handlerAdded0, handlerRemoved, handlerRemoved0, internalBuffer, isSharable, isSingleDecode, setSingleDecode

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelRead, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Constructor Detail

WebSocket13FrameDecoder

public WebSocket13FrameDecoder(boolean expectMaskedFrames,
                               boolean allowExtensions,
                               int maxFramePayloadLength)

Constructor

Parameters:

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

allowExtensions - Flag to allow reserved extension bits to be used or not

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

WebSocket13FrameDecoder

public WebSocket13FrameDecoder(boolean expectMaskedFrames,
                               boolean allowExtensions,
                               int maxFramePayloadLength,
                               boolean allowMaskMismatch)

Constructor

Parameters:

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

allowExtensions - Flag to allow reserved extension bits to be used or not

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

allowMaskMismatch - When set to true, frames which are not masked properly according to the standard will still be accepted.

WebSocket13FrameDecoder

public WebSocket13FrameDecoder(WebSocketDecoderConfig decoderConfig)

Constructor

Parameters:

decoderConfig - Frames decoder configuration.

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      Buffer in)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one Buffer to another. This method will be called till either the input Buffer has nothing to read when return from this method or till nothing was read from the input Buffer.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the Buffer from which to read data

Throws:

Exception - is thrown if an error occurs

checkCloseFrameBody

protected void checkCloseFrameBody(ChannelHandlerContext ctx,
                                   Buffer buffer)