HttpClientUpgradeHandler (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.HttpClientUpgradeHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
public class HttpClientUpgradeHandler
extends HttpObjectAggregator
implements ChannelOutboundHandler
```
用于处理与另一个协议的HTTP升级握手的客户端处理程序。当发送第一个HTTP请求时，该处理程序将添加所有适当的标头以执行到新协议的升级。如果升级失败（即响应不是101切换协议），则此处理程序只是将自己从管道中移除。如果升级成功，则将管道升级到新协议。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HttpClientUpgradeHandler.SourceCodec` 最初在流水线中使用的源代码编解码器。
`static interface`	`HttpClientUpgradeHandler.UpgradeCodec` 源可以升级到的编解码器。
`static class`	`HttpClientUpgradeHandler.UpgradeEvent` 被触发以通知升级状态的用户事件。

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

构造方法摘要

构造方法
Constructor and Description
`HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength)` 构造客户端升级处理程序。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)` 调用一次绑定操作。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 一旦进行了密切的操作，就会被调用。
`void`	`connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` 连接操作完成后调用。
`protected void`	`decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out)` 从一条消息解码到另一条消息。
`void`	`deregister(ChannelHandlerContext ctx, ChannelPromise promise)` 一旦从当前注册的`EventLoop`进行撤销注册操作，就会被调用。
`void`	`disconnect(ChannelHandlerContext ctx, ChannelPromise promise)` 调用一次断开操作。
`void`	`flush(ChannelHandlerContext ctx)` 调用一次冲洗操作。
`void`	`read(ChannelHandlerContext ctx)` 拦截 `ChannelHandlerContext.read()` 。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 一旦写入操作被调用，就调用它。

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

Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved

- 构造方法详细信息
  - HttpClientUpgradeHandler
```
public HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec,
                                HttpClientUpgradeHandler.UpgradeCodec upgradeCodec,
                                int maxContentLength)
```
    构造客户端升级处理程序。
    
    参数
    
    sourceCodec - 最初使用的编解码器。
    
    upgradeCodec - 客户端想要升级到的编解码器。
    
    maxContentLength - 聚合内容的最大长度。
- 方法详细信息
  - bind
```
public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    调用一次绑定操作。
    
    Specified by:
    
    bind在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其进行绑定操作的ChannelHandlerContext
    
    localAddress - 它应该绑定的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - connect
```
public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception
```
    从接口复制的描述： ChannelOutboundHandler
    
    连接操作完成后调用。
    
    Specified by:
    
    connect在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其进行连接操作的ChannelHandlerContext
    
    remoteAddress - 它应该连接的 SocketAddress
    
    localAddress - 用作连接源的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    调用一次断开操作。
    
    Specified by:
    
    disconnect接口 ChannelOutboundHandler
    
    参数
    
    ctx - 为其进行断开操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    一旦进行了密切的操作，就会被调用。
    
    Specified by:
    
    close接口 ChannelOutboundHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - deregister
```
public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    一旦从当前注册的EventLoop开始撤销注册操作，就会被调用。
    
    Specified by:
    
    deregister接口 ChannelOutboundHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - read
```
public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    拦截 ChannelHandlerContext.read() 。
    
    Specified by:
    
    read在界面 ChannelOutboundHandler
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    一旦写入操作被调用，就调用它。写入操作将通过ChannelPipeline写入消息。一旦Channel.flush()被调用，那些准备好被刷新到实际的Channel
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 要写的消息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从接口复制的描述： ChannelOutboundHandler
    
    调用一次冲洗操作。刷新操作将尝试清除所有以前写入的待处理消息。
    
    Specified by:
    
    flush接口 ChannelOutboundHandler
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - 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 HttpClientUpgradeHandler

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

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

HttpClientUpgradeHandler

方法详细信息

bind

connect

disconnect

close

deregister

read

write

flush

decode