Class CleartextHttp2ServerUpgradeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.CleartextHttp2ServerUpgradeHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public final class CleartextHttp2ServerUpgradeHandler
extends ByteToMessageDecoder

Performing cleartext upgrade, by h2c HTTP upgrade or Prior Knowledge. This handler config pipeline for h2c upgrade when handler added. And will update pipeline once it detect the connection is starting HTTP/2 by prior knowledge or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CleartextHttp2ServerUpgradeHandler.PriorKnowledgeUpgradeEvent	User event that is fired to notify about HTTP/2 protocol is started.

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Modifier and Type	Class	Description
static interface	ByteToMessageDecoder.Cumulator	Cumulate ByteBufs.

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Field Summary

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Modifier and Type	Field	Description
static final ByteToMessageDecoder.Cumulator	COMPOSITE_CUMULATOR	Cumulate ByteBufs by add them to a CompositeByteBuf and so do no memory copy whenever possible.
static final ByteToMessageDecoder.Cumulator	MERGE_CUMULATOR	Cumulate ByteBufs by merge them into one ByteBuf's, using memory copies.

Constructor Summary

Constructors

Constructor	Description
CleartextHttp2ServerUpgradeHandler(HttpServerCodec httpServerCodec, HttpServerUpgradeHandler httpServerUpgradeHandler, ChannelHandler http2ServerHandler)	Creates the channel handler provide cleartext HTTP/2 upgrade from HTTP upgrade or prior knowledge

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Peek inbound message to determine current connection wants to start HTTP/2 by HTTP upgrade or prior knowledge
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Modifier and Type	Method	Description
protected int	actualReadableBytes()	Returns the actual number of readable bytes in the internal cumulative buffer of this decoder.
protected void	callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Called once data should be decoded from the given ByteBuf.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object input)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Is called one last time when the ChannelHandlerContext goes in-active.
protected final void	discardSomeReadBytes()
final void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected void	handlerRemoved0(ChannelHandlerContext ctx)	Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
protected ByteBuf	internalBuffer()	Returns the internal cumulative buffer of this decoder.
boolean	isSingleDecode()	If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	setCumulator(ByteToMessageDecoder.Cumulator cumulator)	Set the ByteToMessageDecoder.Cumulator to use for cumulate the received ByteBufs.
void	setDiscardAfterReads(int discardAfterReads)	Set the number of reads after which ByteBuf.discardSomeReadBytes() are called and so free up memory.
void	setSingleDecode(boolean singleDecode)	If set then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

CleartextHttp2ServerUpgradeHandler

public CleartextHttp2ServerUpgradeHandler(HttpServerCodec httpServerCodec,
 HttpServerUpgradeHandler httpServerUpgradeHandler,
 ChannelHandler http2ServerHandler)

Creates the channel handler provide cleartext HTTP/2 upgrade from HTTP upgrade or prior knowledge

Parameters:

httpServerCodec - the http server codec

httpServerUpgradeHandler - the http server upgrade handler for HTTP/2

http2ServerHandler - the http2 server handler, will be added into pipeline when starting HTTP/2 by prior knowledge

Method Details

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

decode

protected void decode(ChannelHandlerContext ctx,
 ByteBuf in,
 List<Object> out)
               throws Exception

Peek inbound message to determine current connection wants to start HTTP/2 by HTTP upgrade or prior knowledge

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs