io.netty.handler.codec.http

类 HttpClientUpgradeHandler

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

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class HttpClientUpgradeHandler
extends HttpObjectAggregator
implements ChannelOutboundHandler

Client-side handler for handling an HTTP upgrade handshake to another protocol. When the first HTTP request is sent, this handler will add all appropriate headers to perform an upgrade to the new protocol. If the upgrade fails (i.e. response is not 101 Switching Protocols), this handler simply removes itself from the pipeline. If the upgrade is successful, upgrades the pipeline to the new protocol.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	HttpClientUpgradeHandler.SourceCodec The source codec that is used in the pipeline initially.
static interface	HttpClientUpgradeHandler.UpgradeCodec A codec that the source can be upgraded to.
static class	HttpClientUpgradeHandler.UpgradeEvent User events that are fired to notify about upgrade status.

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength) Constructs the client upgrade handler.

方法概要

限定符和类型	方法和说明
void	bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise) Called once a bind operation is made.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Called once a close operation is made.
void	connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise) Called once a connect operation is made.
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, java.util.List<java.lang.Object> out) Decode from one message to an other.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise) Called once a deregister operation is made from the current registered EventLoop.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise) Called once a disconnect operation is made.
void	flush(ChannelHandlerContext ctx) Called once a flush operation is made.
void	read(ChannelHandlerContext ctx) Intercepts ChannelHandlerContext.read().
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Called once a write operation is made.

从类继承的方法 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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

构造器详细资料

HttpClientUpgradeHandler

public HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec,
                                HttpClientUpgradeHandler.UpgradeCodec upgradeCodec,
                                int maxContentLength)

Constructs the client upgrade handler.

参数:

sourceCodec - the codec that is being used initially.

upgradeCodec - the codec that the client would like to upgrade to.

maxContentLength - the maximum length of the aggregated content.

方法详细资料

bind

public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a bind operation is made.

指定者:

bind 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the bind operation is made

localAddress - the SocketAddress to which it should bound

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a connect operation is made.

指定者:

connect 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the connect operation is made

remoteAddress - the SocketAddress to which it should connect

localAddress - the SocketAddress which is used as source on connect

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

disconnect

public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a disconnect operation is made.

指定者:

disconnect 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

close

public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a close operation is made.

指定者:

close 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

deregister

public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a deregister operation is made from the current registered EventLoop.

指定者:

deregister 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

read

public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

指定者:

read 在接口中 ChannelOutboundHandler

抛出:

java.lang.Exception

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

指定者:

write 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

flush

public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception

从接口复制的说明: ChannelOutboundHandler

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

指定者:

flush 在接口中 ChannelOutboundHandler

参数:

ctx - the ChannelHandlerContext for which the flush operation is made

抛出:

java.lang.Exception - thrown if an error occurs

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