io.netty.handler.codec.http

Class HttpClientUpgradeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

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

public class HttpClientUpgradeHandler
extends HttpObjectAggregator

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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.

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

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength) Constructs the client upgrade handler.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, HttpObject msg, List<Object> out) Decode from one message to an other.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

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

aggregate, beginAggregation, contentLength, finishAggregation, handleOversizedMessage, hasContentLength, isAggregated, isContentMessage, isLastContentMessage, isStartMessage, newContinueResponse

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

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

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

channelRead

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientUpgradeHandler

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

Constructs the client upgrade handler.

Parameters:

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.

Method Detail

write

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

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

decode

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

Description copied from class: MessageToMessageDecoder

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

Overrides:

decode in class MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Parameters:

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

Throws:

Exception - is thrown if an error accour