Netty/Codec/HTTP2 4.1.107.Final · io.netty.handler.codec.http2.Http2ConnectionHandler

Modifier and Type	Class and Description
private abstract class	Http2ConnectionHandler.BaseDecoder
private static class	Http2ConnectionHandler.ClosingChannelFutureListener Closes the channel when the future completes.
private class	Http2ConnectionHandler.FrameDecoder
private class	Http2ConnectionHandler.PrefaceDecoder

Modifier and Type	Field and Description
private Http2ConnectionHandler.BaseDecoder	byteDecoder
private ChannelFutureListener	closeListener
private final Http2ConnectionDecoder	decoder
private final boolean	decoupleCloseAndGoAway
private final Http2ConnectionEncoder	encoder
private final boolean	flushPreface
private long	gracefulShutdownTimeoutMillis
private static final Http2Headers	HEADERS_TOO_LARGE_HEADERS
private static final ByteBuf	HTTP_1_X_BUF
private final Http2Settings	initialSettings
private static final InternalLogger	logger

Access	Constructor and Description
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings)
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean decoupleCloseAndGoAway)
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean decoupleCloseAndGoAway, boolean flushPreface)

Method Summary

Modifier and Type	Method and Description
public void	bind(ChannelHandlerContext the `ChannelHandlerContext` for which the bind operation is made ctx, SocketAddress the `SocketAddress` to which it should bound localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.bind. Called once a bind operation is made.
public void	channelActive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty.handler.codec.ByteToMessageDecoder.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides io.netty.handler.codec.ByteToMessageDecoder.channelReadComplete. Implements io.netty.channel.ChannelInboundHandler.channelReadComplete. Calls `ChannelHandlerContext#fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
pack-priv final void	channelReadComplete0(ChannelHandlerContext ctx)
public void	channelWritabilityChanged(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelWritabilityChanged. Implements io.netty.channel.ChannelInboundHandler.channelWritabilityChanged. Calls `ChannelHandlerContext#fireChannelWritabilityChanged()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
private void	checkCloseConnection(ChannelFuture Represents the status that will be passed to the `closeListener`. future) Closes the connection if the graceful shutdown process has completed.
private static ByteBuf	clientPrefaceString(Http2Connection connection) Returns the client preface string if this is a client connection, otherwise returns `null`.
public void	close(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.close. Called once a close operation is made.
private void	closeConnectionOnError(ChannelHandlerContext ctx, ChannelFuture future)
public void	closeStream(final Http2Stream the stream to be closed and deactivated. stream, ChannelFuture when completed if `Http2Connection#numActiveStreams()` is 0 then the underlying channel will be closed. future) Implements io.netty.handler.codec.http2.Http2LifecycleManager.closeStream. Closes and deactivates the given `stream`.
public void	closeStreamLocal(Http2Stream the stream to be half closed. stream, ChannelFuture If closing, the future after which to close the channel. future) Implements io.netty.handler.codec.http2.Http2LifecycleManager.closeStreamLocal. Closes the local side of the given stream.
public void	closeStreamRemote(Http2Stream the stream to be half closed. stream, ChannelFuture If closing, the future after which to close the channel. future) Implements io.netty.handler.codec.http2.Http2LifecycleManager.closeStreamRemote. Closes the remote side of the given stream.
public void	connect(ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made ctx, SocketAddress the `SocketAddress` to which it should connect remoteAddress, SocketAddress the `SocketAddress` which is used as source on connect localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.connect. Called once a connect operation is made.
public Http2Connection	connection()
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, ByteBuf the `ByteBuf` from which to read data in, List<Object> the `List` to which decoded messages should be added out) Implements abstract io.netty.handler.codec.ByteToMessageDecoder.decode. Decode the from one `ByteBuf` to an other.
public Http2ConnectionDecoder	decoder()
public void	deregister(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.deregister. Called once a deregister operation is made from the current registered `EventLoop`.
public void	disconnect(ChannelHandlerContext the `ChannelHandlerContext` for which the disconnect operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.disconnect. Called once a disconnect operation is made.
private void	doCloseStream(final Http2Stream stream, ChannelFuture future)
private void	doGracefulShutdown(ChannelHandlerContext ctx, ChannelFuture future, final ChannelPromise promise)
public Http2ConnectionEncoder	encoder()
public void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Handles `Http2Exception` objects that were thrown from other handlers.
public void	flush(ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made ctx) Implements io.netty.channel.ChannelOutboundHandler.flush. Called once a flush operation is made.
protected Http2FrameWriter	frameWriter()
public ChannelFuture	goAway(final ChannelHandlerContext The context used for communication and buffer allocation if necessary. ctx, final int The last stream that the local endpoint is claiming it will accept. lastStreamId, final long The rational as to why the connection is being closed. See `Http2Error`. errorCode, final ByteBuf For diagnostic purposes (carries no semantic value). debugData, ChannelPromise Used to indicate the return status of this operation. promise) Implements io.netty.handler.codec.http2.Http2LifecycleManager.goAway. Prevents the peer from creating streams and close the connection if `errorCode` is not `Http2Error#NO_ERROR`.
private ChannelFuture	goAway(ChannelHandlerContext ctx, Http2Exception cause, ChannelPromise promise) Close the remote endpoint with a `GO_AWAY` frame.
public 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.
public void	gracefulShutdownTimeoutMillis(long 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. 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.
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
protected void	handlerRemoved0(ChannelHandlerContext ctx) Overrides io.netty.handler.codec.ByteToMessageDecoder.handlerRemoved0. Gets called after the `ByteToMessageDecoder` was removed from the actual context and it doesn't handle events anymore.
protected void	handleServerHeaderDecodeSizeError(ChannelHandlerContext the channel context ctx, Http2Stream the Http2Stream on which the header was received 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.
private ChannelFutureListener	newClosingChannelFutureListener(ChannelHandlerContext ctx, ChannelPromise promise)
protected void	onConnectionError(ChannelHandlerContext the channel context ctx, boolean `true` if the error was caused by an outbound operation. outbound, Throwable the exception that was caught cause, Http2Exception the `Http2Exception` that is embedded in the causality chain. This may be `null` if it's an unknown exception. http2Ex) Handler for a connection error.
public void	onError(ChannelHandlerContext The context used for communication and buffer allocation if necessary. ctx, boolean `true` if the error was caused by an outbound operation and so the corresponding `ChannelPromise` was failed as well. outbound, Throwable the error. cause) Implements io.netty.handler.codec.http2.Http2LifecycleManager.onError. Central handler for all exceptions caught during HTTP/2 processing.
public void	onHttpClientUpgrade() Handles the client-side (cleartext) upgrade from HTTP to HTTP/2.
public void	onHttpServerUpgrade(Http2Settings the settings for the remote endpoint. settings) Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.
protected void	onStreamError(ChannelHandlerContext the channel context ctx, boolean `true` if the error was caused by an outbound operation. outbound, Throwable the exception that was caught cause, Http2Exception.StreamException the `StreamException` that is embedded in the causality chain. http2Ex) Handler for a stream error.
private boolean	prefaceSent()
private static void	processGoAwayWriteResult(final ChannelHandlerContext ctx, final int lastStreamId, final long errorCode, final ByteBuf debugData, ChannelFuture future)
private void	processRstStreamWriteResult(ChannelHandlerContext ctx, Http2Stream stream, ChannelFuture future)
public void	read(ChannelHandlerContext ctx) Implements io.netty.channel.ChannelOutboundHandler.read. Intercepts `ChannelHandlerContext#read()`.
public ChannelFuture	resetStream(final ChannelHandlerContext The context used for communication and buffer allocation if necessary. ctx, int The identifier of the stream to reset. streamId, long Justification as to why this stream is being reset. See `Http2Error`. errorCode, ChannelPromise Used to indicate the return status of this operation. promise) Implements io.netty.handler.codec.http2.Http2LifecycleManager.resetStream. Ensure the stream identified by `streamId` is reset.
private ChannelFuture	resetStream(final ChannelHandlerContext ctx, final Http2Stream stream, long errorCode, ChannelPromise promise)
private ChannelFuture	resetUnknownStream(final ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise) Sends a `RST_STREAM` frame even if we don't know about the stream.
public void	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Implements io.netty.channel.ChannelOutboundHandler.write. Called once a write operation is made.

Inherited from io.netty.handler.codec.ByteToMessageDecoder:: actualReadableBytes callDecode channelRead decodeLast discardSomeReadBytes handlerRemoved internalBuffer isSingleDecode setCumulator setDiscardAfterReads setSingleDecode userEventTriggered

public Class Http2ConnectionHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary