Class WebSocket00FrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ReplayingDecoder<Void>

io.netty.handler.codec.http.websocketx.WebSocket00FrameDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, WebSocketFrameDecoder

public class WebSocket00FrameDecoder
extends ReplayingDecoder<Void>
implements WebSocketFrameDecoder

Decodes ByteBufs into WebSocketFrames.

For the detailed instruction on adding add Web Socket support to your HTTP server, take a look into the WebSocketServer example located in the io.netty.example.http.websocket package.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
WebSocket00FrameDecoder()
WebSocket00FrameDecoder(int maxFrameSize)	Creates a new instance of WebSocketFrameDecoder with the specified maxFrameSize.
WebSocket00FrameDecoder(WebSocketDecoderConfig decoderConfig)	Creates a new instance of WebSocketFrameDecoder with the specified maxFrameSize.

Method Summary

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

Methods inherited from class ReplayingDecoder

callDecode, checkpoint, checkpoint, state, state

Methods inherited from class ByteToMessageDecoder

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

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

handlerAdded, handlerRemoved

Methods inherited from interface ChannelInboundHandler

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

Constructor Details

WebSocket00FrameDecoder

public WebSocket00FrameDecoder()

WebSocket00FrameDecoder

public WebSocket00FrameDecoder(int maxFrameSize)

Creates a new instance of WebSocketFrameDecoder with the specified maxFrameSize. If the client sends a frame size larger than maxFrameSize, the channel will be closed.

Parameters:

maxFrameSize - the maximum frame size to decode

WebSocket00FrameDecoder

public WebSocket00FrameDecoder(WebSocketDecoderConfig decoderConfig)

Creates a new instance of WebSocketFrameDecoder with the specified maxFrameSize. If the client sends a frame size larger than maxFrameSize, the channel will be closed.

Parameters:

decoderConfig - Frames decoder configuration.

Method Details

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