io.netty.handler.codec.http

Class HttpServerUpgradeHandler

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.HttpServerUpgradeHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler

public class HttpServerUpgradeHandler
extends HttpObjectAggregator

A server-side handler that receives HTTP requests and optionally performs a protocol switch if the requested protocol is supported. Once an upgrade is performed, this handler removes itself from the pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpServerUpgradeHandler.SourceCodec The source codec that is used in the pipeline initially.
static interface	HttpServerUpgradeHandler.UpgradeCodec A codec that the source can be upgraded to.
static class	HttpServerUpgradeHandler.UpgradeEvent User event that is fired to notify about the completion of an HTTP upgrade to another protocol.

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

io.netty.channel.ChannelHandler.Sharable, io.netty.channel.ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec, Collection<HttpServerUpgradeHandler.UpgradeCodec> upgradeCodecs, int maxContentLength) Constructs the upgrader with the supported codecs.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, HttpObject msg, List<Object> out)

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, write

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerUpgradeHandler

public HttpServerUpgradeHandler(HttpServerUpgradeHandler.SourceCodec sourceCodec,
                        Collection<HttpServerUpgradeHandler.UpgradeCodec> upgradeCodecs,
                        int maxContentLength)

Constructs the upgrader with the supported codecs.

Parameters:

sourceCodec - the codec that is being used initially.

upgradeCodecs - the codecs (in order of preference) that this server supports upgrading to from the source codec.

maxContentLength - the maximum length of the aggregated content.

Method Detail

decode

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

Overrides:

decode in class io.netty.handler.codec.MessageAggregator<HttpObject,HttpMessage,HttpContent,FullHttpMessage>

Throws:

Exception