HttpServerUpgradeHandler (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler
```
public class HttpServerUpgradeHandler
extends HttpObjectAggregator
```
服务器端处理程序，用于接收HTTP请求，并且可以在支持所请求的协议时选择执行协议切换。一旦执行升级，该处理程序将自行从管道中移除。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HttpServerUpgradeHandler.SourceCodec` 最初在流水线中使用的源代码编解码器。
`static interface`	`HttpServerUpgradeHandler.UpgradeCodec` 源可以升级到的编解码器。
`static interface`	`HttpServerUpgradeHandler.UpgradeCodecFactory` 为请求的协议名称创建一个新的`HttpServerUpgradeHandler.UpgradeCodec` 。
`static class`	`HttpServerUpgradeHandler.UpgradeEvent` 用户事件被触发以通知HTTP升级到另一协议的完成。

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory)` 用支持的编解码器构建升级程序。
`HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory, int maxContentLength)` 用支持的编解码器构建升级程序。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out)` 从一条消息解码到另一条消息。

Methods inherited from class io.netty.handler.codec.http.HttpObjectAggregator
aggregate, beginAggregation, closeAfterContinueResponse, finishAggregation, handleOversizedMessage, ignoreContentAfterContinueResponse, isAggregated, isContentLengthInvalid, isContentMessage, isLastContentMessage, isStartMessage, newContinueResponse

Methods inherited from class io.netty.handler.codec.MessageAggregator
acceptInboundMessage, channelInactive, channelReadComplete, ctx, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, setMaxCumulationBufferComponents

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder
channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - HttpServerUpgradeHandler
```
public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory)
```
    用支持的编解码器构建升级程序。
    由此构造函数实例化的处理程序将拒绝具有非空内容的升级请求。不应该担心，因为升级请求很可能是GET请求。如果您有发送非GET升级请求的客户端，请考虑使用HttpServerUpgradeHandler(SourceCodec, UpgradeCodecFactory, int)指定升级请求内容的最大长度。
    
    参数
    
    sourceCodec - 最初使用的编解码器
    
    upgradeCodecFactory - 为请求的升级协议之一创建新升级编解码器的工厂
  - HttpServerUpgradeHandler
```
public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                                HttpServerUpgradeHandler.UpgradeCodecFactory upgradeCodecFactory,
                                int maxContentLength)
```
    用支持的编解码器构建升级程序。
    
    参数
    
    sourceCodec - 最初使用的编解码器
    
    upgradeCodecFactory - 为请求的升级协议之一创建新升级编解码器的工厂
    
    maxContentLength - 升级请求内容的最大长度
- 方法详细信息
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      HttpObject msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToMessageDecoder
    
    从一条消息解码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    重写：
    
    decode在课堂 MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>
    
    参数
    
    ctx - 这MessageToMessageDecoder属于的ChannelHandlerContext
    
    msg - 解码到另一个的消息
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 发生错误时抛出

Class HttpServerUpgradeHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.http.HttpObjectAggregator

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

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

构造方法详细信息

HttpServerUpgradeHandler

HttpServerUpgradeHandler

方法详细信息

decode