Class WebSocket00FrameDecoder
- java.lang.Object
-
- io.netty.channel.ChannelHandlerAdapter
-
- io.netty.channel.ChannelInboundHandlerAdapter
-
- io.netty.handler.codec.ByteToMessageDecoder
-
- io.netty.handler.codec.ReplayingDecoder<java.lang.Void>
-
- io.netty.handler.codec.http.websocketx.WebSocket00FrameDecoder
-
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
,WebSocketFrameDecoder
public class WebSocket00FrameDecoder extends ReplayingDecoder<java.lang.Void> implements WebSocketFrameDecoder
DecodesByteBuf
s intoWebSocketFrame
s.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 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 Description WebSocket00FrameDecoder()
WebSocket00FrameDecoder(int maxFrameSize)
Creates a new instance ofWebSocketFrameDecoder
with the specifiedmaxFrameSize
.WebSocket00FrameDecoder(WebSocketDecoderConfig decoderConfig)
Creates a new instance ofWebSocketFrameDecoder
with the specifiedmaxFrameSize
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
to an other.-
Methods inherited from class io.netty.handler.codec.ReplayingDecoder
callDecode, checkpoint, checkpoint, state, state
-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, 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.ChannelHandler
handlerAdded, handlerRemoved
-
Methods inherited from interface io.netty.channel.ChannelInboundHandler
channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered
-
-
-
-
Constructor Detail
-
WebSocket00FrameDecoder
public WebSocket00FrameDecoder()
-
WebSocket00FrameDecoder
public WebSocket00FrameDecoder(int maxFrameSize)
Creates a new instance ofWebSocketFrameDecoder
with the specifiedmaxFrameSize
. If the client sends a frame size larger thanmaxFrameSize
, the channel will be closed.- Parameters:
maxFrameSize
- the maximum frame size to decode
-
WebSocket00FrameDecoder
public WebSocket00FrameDecoder(WebSocketDecoderConfig decoderConfig)
Creates a new instance ofWebSocketFrameDecoder
with the specifiedmaxFrameSize
. If the client sends a frame size larger thanmaxFrameSize
, the channel will be closed.- Parameters:
decoderConfig
- Frames decoder configuration.
-
-
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 oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
java.lang.Exception
- is thrown if an error occurs
-
-