io.netty.handler.codec.http

类 HttpServerUpgradeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<I>

io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

io.netty.handler.codec.http.HttpObjectAggregator

io.netty.handler.codec.http.HttpServerUpgradeHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public class HttpServerUpgradeHandler
extends HttpObjectAggregator

A server-side handler that receives HTTP requests and optionally performs a protocol switch if the requested protocol is supported. Once an upgrade is performed, this handler removes itself from the pipeline.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	HttpServerUpgradeHandler.SourceCodec The source codec that is used in the pipeline initially.
static interface	HttpServerUpgradeHandler.UpgradeCodec A codec that the source can be upgraded to.
static interface	HttpServerUpgradeHandler.UpgradeCodecFactory Creates a new HttpServerUpgradeHandler.UpgradeCodec for the requested protocol name.
static class	HttpServerUpgradeHandler.UpgradeEvent User event that is fired to notify about the completion of an HTTP upgrade to another protocol.

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory) Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength) Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength, boolean validateHeaders) Constructs the upgrader with the supported codecs.
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength, HttpHeadersFactory headersFactory, HttpHeadersFactory trailersFactory) Constructs the upgrader with the supported codecs.

方法概要

限定符和类型	方法和说明
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out) Decode from one message to an other.
protected boolean	shouldHandleUpgradeRequest(HttpRequest req) Determines whether the specified upgrade HttpRequest should be handled by this handler or not.

从类继承的方法 io.netty.handler.codec.http.HttpObjectAggregator

aggregate, beginAggregation, closeAfterContinueResponse, finishAggregation, handleOversizedMessage, ignoreContentAfterContinueResponse, isAggregated, isContentLengthInvalid, isContentMessage, isLastContentMessage, isStartMessage, newContinueResponse

从类继承的方法 io.netty.handler.codec.MessageAggregator

acceptInboundMessage, channelInactive, channelReadComplete, ctx, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, setMaxCumulationBufferComponents

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

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

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

构造器详细资料

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory)

Constructs the upgrader with the supported codecs.

The handler instantiated by this constructor will reject an upgrade request with non-empty content. It should not be a concern because an upgrade request is most likely a GET request. If you have a client that sends a non-GET upgrade request, please consider using HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int) to specify the maximum length of the content of an upgrade request.

参数:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength)

Constructs the upgrader with the supported codecs.

参数:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength,
                                boolean validateHeaders)

Constructs the upgrader with the supported codecs.

参数:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

validateHeaders - validate the header names and values of the upgrade response.

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength,
                                HttpHeadersFactory headersFactory,
                                HttpHeadersFactory trailersFactory)

Constructs the upgrader with the supported codecs.

参数:

sourceCodec - the codec that is being used initially

upgradeCodecFactory - the factory that creates a new upgrade codec for one of the requested upgrade protocols

maxContentLength - the maximum length of the content of an upgrade request

headersFactory - The HttpHeadersFactory to use for headers. The recommended default factory is DefaultHttpHeadersFactory.headersFactory().

trailersFactory - The HttpHeadersFactory to use for trailers. The recommended default factory is DefaultHttpHeadersFactory.trailersFactory().

方法详细资料

decode

protected void decode(ChannelHandlerContext ctx,
                      HttpObject msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception

从类复制的说明: MessageToMessageDecoder

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

覆盖:

decode 在类中 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

参数:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

抛出:

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

shouldHandleUpgradeRequest

protected boolean shouldHandleUpgradeRequest(HttpRequest req)

Determines whether the specified upgrade HttpRequest should be handled by this handler or not. This method will be invoked only when the request contains an Upgrade header. It always returns true by default, which means any request with an Upgrade header will be handled. You can override this method to ignore certain Upgrade headers, for example:

{@code