Netty 5.0.0.Alpha5 · io.netty5.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 FutureListener<Object>	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 Buffer	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	channelActive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelActive. The `Channel` of the `ChannelHandlerContext` is now active
public void	channelExceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides default io.netty5.channel.ChannelHandler.channelExceptionCaught. Handles `Http2Exception` objects that were thrown from other handlers.
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.channelInactive. Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.channelReadComplete. Overrides default io.netty5.channel.ChannelHandler.channelReadComplete. Invoked when the last message read by the current read operation has been consumed by `channelRead(ChannelHandlerContext, Object)`.
pack-priv final void	channelReadComplete0(ChannelHandlerContext ctx)
public void	channelWritabilityChanged(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelWritabilityChanged. Gets called once the writable state of a `Channel` changed.
private void	checkCloseConnection(Future<?> Represents the status that will be passed to the `closeListener`. future) Closes the connection if the graceful shutdown process has completed.
private static Buffer	clientPrefaceString(Http2Connection connection) Returns the client preface string if this is a client connection, otherwise returns `null`.
public Future<Void>	close(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx) Overrides default io.netty5.channel.ChannelHandler.close. Called once a close operation is made.
private void	closeConnectionOnError(ChannelHandlerContext ctx, Future<?> future)
public void	closeStream(final Http2Stream the stream to be closed and deactivated. stream, Future<Void> when completed if `Http2Connection#numActiveStreams()` is 0 then the underlying channel will be closed. future) Implements io.netty5.handler.codec.http2.Http2LifecycleManager.closeStream. Closes and deactivates the given `stream`.
public void	closeStreamLocal(Http2Stream the stream to be half closed. stream, Future<Void> If closing, the future after which to close the channel. future) Implements io.netty5.handler.codec.http2.Http2LifecycleManager.closeStreamLocal. Closes the local side of the given stream.
public void	closeStreamRemote(Http2Stream the stream to be half closed. stream, Future<Void> If closing, the future after which to close the channel. future) Implements io.netty5.handler.codec.http2.Http2LifecycleManager.closeStreamRemote. Closes the remote side of the given stream.
public Http2Connection	connection()
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, Buffer the `Buffer` from which to read data in) Implements abstract io.netty5.handler.codec.ByteToMessageDecoder.decode. Decode the from one `Buffer` to another.
public Http2ConnectionDecoder	decoder()
private void	doGracefulShutdown(ChannelHandlerContext ctx, Future<Void> future, final Promise<Void> promise)
public Http2ConnectionEncoder	encoder()
public void	flush(ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made ctx) Overrides default io.netty5.channel.ChannelHandler.flush. Called once a flush operation is made.
protected Http2FrameWriter	frameWriter()
public Future<Void>	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 Buffer For diagnostic purposes (carries no semantic value). debugData) Implements io.netty5.handler.codec.http2.Http2LifecycleManager.goAway. Prevents the peer from creating streams and close the connection if `errorCode` is not `Http2Error#NO_ERROR`.
private Future<Void>	goAway(ChannelHandlerContext ctx, Http2Exception cause) 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	handlerAdded0(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerAdded0.
protected void	handlerRemoved0(ChannelHandlerContext ctx) Overrides io.netty5.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 FutureListener<Object>	newClosingChannelFutureListener(ChannelHandlerContext ctx, Promise<Void> 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 `Promise` was failed as well. outbound, Throwable the error. cause) Implements io.netty5.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 Buffer debugData, Future<?> future)
private void	processRstStreamWriteResult(ChannelHandlerContext ctx, Http2Stream stream, Future<?> future)
public Future<Void>	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) Implements io.netty5.handler.codec.http2.Http2LifecycleManager.resetStream. Ensure the stream identified by `streamId` is reset.
private Future<Void>	resetStream(final ChannelHandlerContext ctx, final Http2Stream stream, long errorCode)
private Future<Void>	resetUnknownStream(final ChannelHandlerContext ctx, int streamId, long errorCode) Sends a `RST_STREAM` frame even if we don't know about the stream.

Inherited from io.netty5.handler.codec.ByteToMessageDecoder:: actualReadableBytes channelRead channelShutdown decodeLast discardSomeReadBytes handlerAdded handlerRemoved internalBuffer isSharable isSingleDecode setSingleDecode

public Class Http2ConnectionHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary