org.jboss.netty.handler.codec.http.websocketx

类 WebSocket08FrameDecoder

java.lang.Object

org.jboss.netty.channel.SimpleChannelUpstreamHandler

org.jboss.netty.handler.codec.frame.FrameDecoder

org.jboss.netty.handler.codec.replay.ReplayingDecoder<WebSocket08FrameDecoder.State>

org.jboss.netty.handler.codec.http.websocketx.WebSocket08FrameDecoder

所有已实现的接口:

ChannelHandler, ChannelUpstreamHandler, LifeCycleAwareChannelHandler

直接已知子类:

WebSocket07FrameDecoder, WebSocket13FrameDecoder

public class WebSocket08FrameDecoder
extends ReplayingDecoder<WebSocket08FrameDecoder.State>

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

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebSocket08FrameDecoder.State

从接口继承的嵌套类/接口 org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

从类继承的字段 org.jboss.netty.handler.codec.frame.FrameDecoder

cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

构造器概要

构造器

构造器和说明
WebSocket08FrameDecoder(boolean maskedPayload, boolean allowExtensions) Constructor with default values
WebSocket08FrameDecoder(boolean maskedPayload, boolean allowExtensions, long maxFramePayloadLength) Constructor

方法概要

方法

限定符和类型	方法和说明
protected void	checkCloseFrameBody(Channel channel, ChannelBuffer buffer)
protected java.lang.Object	decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, WebSocket08FrameDecoder.State state) Decodes the received packets so far into a frame.

从类继承的方法 org.jboss.netty.handler.codec.replay.ReplayingDecoder

checkpoint, checkpoint, cleanup, decode, decodeLast, decodeLast, getState, internalBuffer, messageReceived, setState

从类继承的方法 org.jboss.netty.handler.codec.frame.FrameDecoder

actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, isUnfold, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation

从类继承的方法 org.jboss.netty.channel.SimpleChannelUpstreamHandler

channelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeComplete

从类继承的方法 java.lang.Object

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

构造器详细资料

WebSocket08FrameDecoder

public WebSocket08FrameDecoder(boolean maskedPayload,
                       boolean allowExtensions)

Constructor with default values

参数:

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

WebSocket08FrameDecoder

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

Constructor

参数:

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.

方法详细资料

decode

protected java.lang.Object decode(ChannelHandlerContext ctx,
                      Channel channel,
                      ChannelBuffer buffer,
                      WebSocket08FrameDecoder.State state)
                           throws java.lang.Exception

从类复制的说明: ReplayingDecoder

Decodes the received packets so far into a frame.

指定者:

decode 在类中 ReplayingDecoder<WebSocket08FrameDecoder.State>

参数:

ctx - the context of this handler

channel - the current channel

buffer - the cumulative buffer of received packets so far. Note that the buffer might be empty, which means you should not make an assumption that the buffer contains at least one byte in your decoder implementation.

state - the current decoder state (null if unused)

返回:

the decoded frame

抛出:

java.lang.Exception

checkCloseFrameBody

protected void checkCloseFrameBody(Channel channel,
                       ChannelBuffer buffer)
                            throws CorruptedFrameException

抛出:

CorruptedFrameException