ProxyHandler (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.proxy.ProxyHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler

已知直接子类：

HttpProxyHandler ， Socks4ProxyHandler ， Socks5ProxyHandler
```
public abstract class ProxyHandler
extends ChannelDuplexHandler
```

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`ProxyHandler(java.net.SocketAddress proxyAddress)`

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`protected abstract void`	`addCodec(ChannelHandlerContext ctx)` 添加与代理服务器进行通信所需的编解码器处理程序。
`abstract java.lang.String`	`authScheme()` 返回正在使用的认证方案的名称。
`void`	`channelActive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelActive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发到`ChannelInboundHandler`中的下一个`ChannelInboundHandler` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`前往`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` 致电`ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)`转发到下一个`ChannelOutboundHandler`的`ChannelPipeline` 。
`Future<Channel>`	`connectFuture()` 返回到目标连接已建立或连接尝试失败时通知的`Future` 。
`long`	`connectTimeoutMillis()` 以毫秒为单位返回连接超时。
`<T extends java.net.SocketAddress> T`	`destinationAddress()` 返回通过代理服务器连接的目标地址。
`void`	`exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)` 致电`ChannelHandlerContext.fireExceptionCaught(Throwable)`转发到`ChannelPipeline`中的下一个`ChannelHandler` 。
`protected java.lang.String`	`exceptionMessage(java.lang.String msg)` 使用当前协议，验证方案，代理地址和目标地址等公共信息装饰指定的异常消息。
`void`	`flush(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.flush()`转发到8262565045669002中的下一个`ChannelOutboundHandler` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected abstract boolean`	`handleResponse(ChannelHandlerContext ctx, java.lang.Object response)` 处理从代理服务器收到的消息。
`boolean`	`isConnected()` 当且仅当与目的地的连接已成功建立时返回 `true` 。
`protected abstract java.lang.Object`	`newInitialMessage(ChannelHandlerContext ctx)` 返回到代理服务器的连接建立后第一次发送的新消息。
`abstract java.lang.String`	`protocol()` 返回正在使用的代理协议的名称。
`<T extends java.net.SocketAddress> T`	`proxyAddress()` 返回代理服务器的地址。
`protected abstract void`	`removeDecoder(ChannelHandlerContext ctx)` 删除 `addCodec(ChannelHandlerContext)`中添加的解码器。
`protected abstract void`	`removeEncoder(ChannelHandlerContext ctx)` 删除 `addCodec(ChannelHandlerContext)`中添加的编码器。
`protected void`	`sendToProxyServer(java.lang.Object msg)` 将指定的消息发送到代理服务器。
`void`	`setConnectTimeoutMillis(long connectTimeoutMillis)` 以毫秒为单位设置连接超时。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 请致电`ChannelOutboundInvoker.write(Object, ChannelPromise)`转发至`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

Methods inherited from class io.netty.channel.ChannelDuplexHandler
bind, close, deregister, disconnect, read

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

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerRemoved, 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
handlerRemoved

- 构造方法详细信息
  - ProxyHandler
```
protected ProxyHandler(java.net.SocketAddress proxyAddress)
```
- 方法详细信息
  - protocol
```
public abstract java.lang.String protocol()
```
    返回正在使用的代理协议的名称。
  - authScheme
```
public abstract java.lang.String authScheme()
```
    返回正在使用的认证方案的名称。
  - proxyAddress
```
public final <T extends java.net.SocketAddress> T proxyAddress()
```
    返回代理服务器的地址。
  - destinationAddress
```
public final <T extends java.net.SocketAddress> T destinationAddress()
```
    返回通过代理服务器连接的目标地址。
  - isConnected
```
public final boolean isConnected()
```
    当且仅当与目的地的连接已成功建立时返回 true 。
  - connectFuture
```
public final Future<Channel> connectFuture()
```
    返回到目标连接已建立或连接尝试失败时通知的Future 。
  - connectTimeoutMillis
```
public final long connectTimeoutMillis()
```
    以毫秒为单位返回连接超时。如果到达目的地的连接尝试未在超时内完成，则连接尝试将失败。
  - setConnectTimeoutMillis
```
public final void setConnectTimeoutMillis(long connectTimeoutMillis)
```
    以毫秒为单位设置连接超时。如果到达目的地的连接尝试未在超时内完成，则连接尝试将失败。
  - handlerAdded
```
public final void handlerAdded(ChannelHandlerContext ctx)
                        throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded ，界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - addCodec
```
protected abstract void addCodec(ChannelHandlerContext ctx)
                          throws java.lang.Exception
```
    添加与代理服务器进行通信所需的编解码器处理程序。
    
    异常
    
    java.lang.Exception
  - removeEncoder
```
protected abstract void removeEncoder(ChannelHandlerContext ctx)
                               throws java.lang.Exception
```
    删除 addCodec(ChannelHandlerContext)中添加的编码器。
    
    异常
    
    java.lang.Exception
  - removeDecoder
```
protected abstract void removeDecoder(ChannelHandlerContext ctx)
                               throws java.lang.Exception
```
    删除 addCodec(ChannelHandlerContext)中添加的解码器。
    
    异常
    
    java.lang.Exception
  - connect
```
public final void connect(ChannelHandlerContext ctx,
                          java.net.SocketAddress remoteAddress,
                          java.net.SocketAddress localAddress,
                          ChannelPromise promise)
                   throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    connect在界面 ChannelOutboundHandler
    
    重写：
    
    connect在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 进行连接操作的ChannelHandlerContext
    
    remoteAddress - 它应该连接的 SocketAddress
    
    localAddress - 用作连接源的 SocketAddress
    
    promise - 操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelActive
```
public final void channelActive(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelActive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelActive在界面 ChannelInboundHandler
    
    重写：
    
    channelActive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - newInitialMessage
```
protected abstract java.lang.Object newInitialMessage(ChannelHandlerContext ctx)
                                               throws java.lang.Exception
```
    返回到代理服务器的连接建立后第一次发送的新消息。
    
    结果
    
    如果代理服务器预期发送第一条消息， null
    
    异常
    
    java.lang.Exception
  - sendToProxyServer
```
protected final void sendToProxyServer(java.lang.Object msg)
```
    将指定的消息发送到代理服务器。使用此方法在handleResponse(ChannelHandlerContext, Object)中向代理服务器发送响应。
  - channelInactive
```
public final void channelInactive(ChannelHandlerContext ctx)
                           throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - exceptionCaught
```
public final void exceptionCaught(ChannelHandlerContext ctx,
                                  java.lang.Throwable cause)
                           throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireExceptionCaught(Throwable)转发至ChannelPipeline中的下一个ChannelHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    exceptionCaught在界面 ChannelHandler
    
    Specified by:
    
    exceptionCaught在界面 ChannelInboundHandler
    
    重写：
    
    exceptionCaught在课程 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRead
```
public final void channelRead(ChannelHandlerContext ctx,
                              java.lang.Object msg)
                       throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发给ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead在界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handleResponse
```
protected abstract boolean handleResponse(ChannelHandlerContext ctx,
                                          java.lang.Object response)
                                   throws java.lang.Exception
```
    处理从代理服务器收到的消息。
    
    结果
    
    true如果到目的地的连接已经建立， false如果到目的地的连接尚未建立，并且代理服务器需要更多消息
    
    异常
    
    java.lang.Exception
  - exceptionMessage
```
protected final java.lang.String exceptionMessage(java.lang.String msg)
```
    使用当前协议，验证方案，代理地址和目标地址等公共信息装饰指定的异常消息。
  - channelReadComplete
```
public final void channelReadComplete(ChannelHandlerContext ctx)
                               throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - write
```
public final void write(ChannelHandlerContext ctx,
                        java.lang.Object msg,
                        ChannelPromise promise)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    请致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - flush
```
public final void flush(ChannelHandlerContext ctx)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelHandlerContext.flush()转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    flush在界面 ChannelOutboundHandler
    
    重写：
    
    flush在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出

Class ProxyHandler

Nested Class Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelDuplexHandler

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

构造方法详细信息

ProxyHandler

方法详细信息

protocol

authScheme

proxyAddress

destinationAddress

isConnected

connectFuture

connectTimeoutMillis

setConnectTimeoutMillis

handlerAdded

addCodec

removeEncoder

removeDecoder

connect

channelActive

newInitialMessage

sendToProxyServer

channelInactive

exceptionCaught

channelRead

handleResponse

exceptionMessage

channelReadComplete

write

flush