io.netty.handler.codec.http.websocketx

Class WebSocket07FrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

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

io.netty.handler.codec.http.websocketx.WebSocket07FrameDecoder

All Implemented Interfaces:

ChannelHandler, WebSocketFrameDecoder

public class WebSocket07FrameDecoder
extends WebSocket08FrameDecoder

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

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, ChannelHandler.Skip

Field Summary

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
WebSocket07FrameDecoder(boolean expectMaskedFrames, boolean allowExtensions, int maxFramePayloadLength) Constructor
WebSocket07FrameDecoder(boolean expectMaskedFrames, boolean allowExtensions, int maxFramePayloadLength, boolean allowMaskMismatch) Constructor

Method Summary

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocket08FrameDecoder

checkCloseFrameBody, decode

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

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

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, isSharable, read, userEventTriggered, write

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.ChannelHandler

bind, channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, read, userEventTriggered, write

Constructor Detail

WebSocket07FrameDecoder

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

WebSocket07FrameDecoder

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