io.netty.handler.codec.http.websocketx

Class WebSocket08FrameDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder<O>

io.netty.handler.codec.ReplayingDecoder<WebSocketFrame,WebSocket08FrameDecoder.State>

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelStateHandler

Direct Known Subclasses:

WebSocket13FrameDecoder

public class WebSocket08FrameDecoder
extends io.netty.handler.codec.ReplayingDecoder<WebSocketFrame,WebSocket08FrameDecoder.State>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocket08FrameDecoder.State

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocket08FrameDecoder(boolean maskedPayload, boolean allowExtensions, int maxFramePayloadLength) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkCloseFrameBody(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buffer)
WebSocketFrame	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in)

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

actualReadableBytes, callDecode, channelInactive, checkpoint, checkpoint, internalBuffer, newInboundBuffer, state, state

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

beforeAdd, decodeLast, inboundBufferUpdated, replace

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeRemove, channelActive, channelRegistered, channelUnregistered, exceptionCaught, userEventTriggered

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

channelActive, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught, userEventTriggered

Constructor Detail

WebSocket08FrameDecoder

public WebSocket08FrameDecoder(boolean maskedPayload,
                       boolean allowExtensions,
                       int maxFramePayloadLength)

Constructor

Parameters:

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

Method Detail

decode

public WebSocketFrame decode(io.netty.channel.ChannelHandlerContext ctx,
                    io.netty.buffer.ByteBuf in)
                      throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageDecoder<WebSocketFrame>

Throws:

Exception

checkCloseFrameBody

protected void checkCloseFrameBody(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.buffer.ByteBuf buffer)
                            throws io.netty.handler.codec.CorruptedFrameException

Throws:

io.netty.handler.codec.CorruptedFrameException