Class HttpToHttp2ConnectionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.Http2ConnectionHandler

io.netty.handler.codec.http2.HttpToHttp2ConnectionHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, Http2LifecycleManager

public class HttpToHttp2ConnectionHandler
extends Http2ConnectionHandler

Translates HTTP/1.x object writes into HTTP/2 frames.

See InboundHttp2ToHttpAdapter to get translation from HTTP/2 frames to HTTP/1.x objects.

Nested Class Summary

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

Modifier	Constructor	Description
protected	HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean validateHeaders)
protected	HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean validateHeaders, boolean decoupleCloseAndGoAway)
protected	HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean validateHeaders, boolean decoupleCloseAndGoAway, boolean flushPreface, HttpScheme httpScheme)
protected	HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean validateHeaders, boolean decoupleCloseAndGoAway, HttpScheme httpScheme)

Method Summary

Modifier and Type	Method	Description
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Handles conversion of HttpMessage and HttpContent to HTTP/2 frames.

Methods inherited from class Http2ConnectionHandler

bind, channelActive, channelInactive, channelReadComplete, channelWritabilityChanged, close, closeStream, closeStreamLocal, closeStreamRemote, connect, connection, decode, decoder, deregister, disconnect, encoder, exceptionCaught, flush, frameWriter, goAway, gracefulShutdownTimeoutMillis, gracefulShutdownTimeoutMillis, handlerAdded, handlerRemoved0, handleServerHeaderDecodeSizeError, isGracefulShutdownComplete, onConnectionError, onError, onHttpClientUpgrade, onHttpServerUpgrade, onStreamError, read, resetStream

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() 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.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
void	closeStream(Http2Stream stream, ChannelFuture future)	Closes and deactivates the given stream.
void	closeStreamLocal(Http2Stream stream, ChannelFuture future)	Closes the local side of the given stream.
void	closeStreamRemote(Http2Stream stream, ChannelFuture future)	Closes the remote side of the given stream.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
Http2Connection	connection()
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
Http2ConnectionDecoder	decoder()
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.
Http2ConnectionEncoder	encoder()
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Handles Http2Exception objects that were thrown from other handlers.
void	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
protected Http2FrameWriter	frameWriter()
ChannelFuture	goAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)	Prevents the peer from creating streams and close the connection if errorCode is not Http2Error.NO_ERROR.
long	gracefulShutdownTimeoutMillis()	Get the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.
void	gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)	Set the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.
void	handlerAdded(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 void	handleServerHeaderDecodeSizeError(ChannelHandlerContext ctx, Http2Stream stream)	Notifies client that this server has received headers that are larger than what it is willing to accept.
protected boolean	isGracefulShutdownComplete()	Called by the graceful shutdown logic to determine when it is safe to close the connection.
protected void	onConnectionError(ChannelHandlerContext ctx, boolean outbound, Throwable cause, Http2Exception http2Ex)	Handler for a connection error.
void	onError(ChannelHandlerContext ctx, boolean outbound, Throwable cause)	Central handler for all exceptions caught during HTTP/2 processing.
void	onHttpClientUpgrade()	Handles the client-side (cleartext) upgrade from HTTP to HTTP/2.
void	onHttpServerUpgrade(Http2Settings settings)	Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.
protected void	onStreamError(ChannelHandlerContext ctx, boolean outbound, Throwable cause, Http2Exception.StreamException http2Ex)	Handler for a stream error.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
ChannelFuture	resetStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)	Ensure the stream identified by streamId is reset.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, 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	channelRead(ChannelHandlerContext ctx, Object input)	Calls ChannelHandlerContext.fireChannelRead(Object) 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 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

channelRegistered, channelUnregistered

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

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

HttpToHttp2ConnectionHandler

protected HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder,
 Http2ConnectionEncoder encoder,
 Http2Settings initialSettings,
 boolean validateHeaders)

HttpToHttp2ConnectionHandler

protected HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder,
 Http2ConnectionEncoder encoder,
 Http2Settings initialSettings,
 boolean validateHeaders,
 boolean decoupleCloseAndGoAway)

HttpToHttp2ConnectionHandler

protected HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder,
 Http2ConnectionEncoder encoder,
 Http2Settings initialSettings,
 boolean validateHeaders,
 boolean decoupleCloseAndGoAway,
 HttpScheme httpScheme)

HttpToHttp2ConnectionHandler

protected HttpToHttp2ConnectionHandler(Http2ConnectionDecoder decoder,
 Http2ConnectionEncoder encoder,
 Http2Settings initialSettings,
 boolean validateHeaders,
 boolean decoupleCloseAndGoAway,
 boolean flushPreface,
 HttpScheme httpScheme)

Method Details

write

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

Handles conversion of HttpMessage and HttpContent to HTTP/2 frames.

Specified by:

write in interface ChannelOutboundHandler

Overrides:

write in class Http2ConnectionHandler

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