io.netty.handler.codec.http.websocketx

Class WebSocket08FrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http.websocketx.WebSocket08FrameDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, WebSocketFrameDecoder

Direct Known Subclasses:

WebSocket07FrameDecoder, WebSocket13FrameDecoder

public class WebSocket08FrameDecoder
extends ByteToMessageDecoder
implements WebSocketFrameDecoder

Decodes a web socket frame from wire protocol version 8 format. This code was forked from webbit and modified.

Nested Class Summary

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

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	checkCloseFrameBody(ChannelHandlerContext ctx, ByteBuf buffer)
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.

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

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelInboundHandler

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

WebSocket08FrameDecoder

public WebSocket08FrameDecoder(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.

WebSocket08FrameDecoder

public WebSocket08FrameDecoder(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.

WebSocket08FrameDecoder

public WebSocket08FrameDecoder(WebSocketDecoderConfig decoderConfig)

Constructor

Parameters:

decoderConfig - Frames decoder configuration.

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

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

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

checkCloseFrameBody

protected void checkCloseFrameBody(ChannelHandlerContext ctx,
                                   ByteBuf buffer)