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.ReplayingDecoder<WebSocket08FrameDecoder.State>

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

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, WebSocketFrameDecoder

Direct Known Subclasses:

WebSocket07FrameDecoder, WebSocket13FrameDecoder

public class WebSocket08FrameDecoder
extends ReplayingDecoder<WebSocket08FrameDecoder.State>
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

Modifier and Type	Class and Description
(package private) static class	WebSocket08FrameDecoder.State

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

Modifier and Type	Field and Description
private boolean	allowExtensions
private int	fragmentedFramesCount
private boolean	frameFinalFlag
private int	frameOpcode
private ByteBuf	framePayload
private int	framePayloadBytesRead
private long	framePayloadLength
private int	frameRsv
private static InternalLogger	logger
private boolean	maskedPayload
private byte[]	maskingKey
private long	maxFramePayloadLength
private static byte	OPCODE_BINARY
private static byte	OPCODE_CLOSE
private static byte	OPCODE_CONT
private static byte	OPCODE_PING
private static byte	OPCODE_PONG
private static byte	OPCODE_TEXT
private ByteBuf	payloadBuffer
private boolean	receivedClosingHandshake
private Utf8Validator	utf8Validator

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	checkCloseFrameBody(ChannelHandlerContext ctx, ByteBuf buffer)
private void	checkUTF8String(ChannelHandlerContext ctx, ByteBuf buffer)
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) Decode the from one ByteBuf to an other.
private void	protocolViolation(ChannelHandlerContext ctx, CorruptedFrameException ex)
private void	protocolViolation(ChannelHandlerContext ctx, java.lang.String reason)
private static int	toFrameLength(long l)
private void	unmask(ByteBuf frame)

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

callDecode, checkpoint, checkpoint, state, state

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

actualReadableBytes, 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

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, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

logger

private static final InternalLogger logger

OPCODE_CONT

private static final byte OPCODE_CONT

See Also:

Constant Field Values

OPCODE_TEXT

private static final byte OPCODE_TEXT

See Also:

Constant Field Values

OPCODE_BINARY

private static final byte OPCODE_BINARY

See Also:

Constant Field Values

OPCODE_CLOSE

private static final byte OPCODE_CLOSE

See Also:

Constant Field Values

OPCODE_PING

private static final byte OPCODE_PING

See Also:

Constant Field Values

OPCODE_PONG

private static final byte OPCODE_PONG

See Also:

Constant Field Values

fragmentedFramesCount

private int fragmentedFramesCount

maxFramePayloadLength

private final long maxFramePayloadLength

frameFinalFlag

private boolean frameFinalFlag

frameRsv

private int frameRsv

frameOpcode

private int frameOpcode

framePayloadLength

private long framePayloadLength

framePayload

private ByteBuf framePayload

framePayloadBytesRead

private int framePayloadBytesRead

maskingKey

private byte[] maskingKey

payloadBuffer

private ByteBuf payloadBuffer

allowExtensions

private final boolean allowExtensions

maskedPayload

private final boolean maskedPayload

receivedClosingHandshake

private boolean receivedClosingHandshake

utf8Validator

private Utf8Validator utf8Validator

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

protected void decode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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:

java.lang.Exception - is thrown if an error accour

unmask

private void unmask(ByteBuf frame)

protocolViolation

private void protocolViolation(ChannelHandlerContext ctx,
                               java.lang.String reason)

protocolViolation

private void protocolViolation(ChannelHandlerContext ctx,
                               CorruptedFrameException ex)

toFrameLength

private static int toFrameLength(long l)

checkUTF8String

private void checkUTF8String(ChannelHandlerContext ctx,
                             ByteBuf buffer)

checkCloseFrameBody

protected void checkCloseFrameBody(ChannelHandlerContext ctx,
                                   ByteBuf buffer)

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ByteToMessageDecoder

Throws:

java.lang.Exception