io.netty.handler.codec.http2

Interface Http2LifecycleManager

All Known Implementing Classes:

Http2ConnectionHandler, HttpToHttp2ConnectionHandler

public interface Http2LifecycleManager

Manager for the life cycle of the HTTP/2 connection. Handles graceful shutdown of the channel, closing only after all of the streams have closed.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeLocalSide(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the local side of the given stream.
void	closeRemoteSide(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the remote side of the given stream.
void	closeStream(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the given stream and adds a hook to deactivate the stream and close the channel after the given future completes.
void	onException(io.netty.channel.ChannelHandlerContext ctx, Throwable cause) Processes the given exception.
io.netty.channel.ChannelFuture	writeGoAway(io.netty.channel.ChannelHandlerContext ctx, int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData, io.netty.channel.ChannelPromise promise) Sends a GO_AWAY frame to the remote endpoint and updates the connection state appropriately.
io.netty.channel.ChannelFuture	writeRstStream(io.netty.channel.ChannelHandlerContext ctx, int streamId, long errorCode, io.netty.channel.ChannelPromise promise) Writes a RST_STREAM frame to the remote endpoint and updates the connection state appropriately.

Method Detail

closeLocalSide

void closeLocalSide(Http2Stream stream,
                  io.netty.channel.ChannelFuture future)

Closes the local side of the given stream. If this causes the stream to be closed, adds a hook to deactivate the stream and close the channel after the given future completes.

Parameters:

stream - the stream to be half closed.

future - If closing, the future after which to close the channel.

closeRemoteSide

void closeRemoteSide(Http2Stream stream,
                   io.netty.channel.ChannelFuture future)

Closes the remote side of the given stream. If this causes the stream to be closed, adds a hook to deactivate the stream and close the channel after the given future completes.

Parameters:

stream - the stream to be half closed.

future - If closing, the future after which to close the channel.

closeStream

void closeStream(Http2Stream stream,
               io.netty.channel.ChannelFuture future)

Closes the given stream and adds a hook to deactivate the stream and close the channel after the given future completes.

Parameters:

stream - the stream to be closed.

future - the future after which to close the channel.

writeRstStream

io.netty.channel.ChannelFuture writeRstStream(io.netty.channel.ChannelHandlerContext ctx,
                                            int streamId,
                                            long errorCode,
                                            io.netty.channel.ChannelPromise promise)

Writes a RST_STREAM frame to the remote endpoint and updates the connection state appropriately.

writeGoAway

io.netty.channel.ChannelFuture writeGoAway(io.netty.channel.ChannelHandlerContext ctx,
                                         int lastStreamId,
                                         long errorCode,
                                         io.netty.buffer.ByteBuf debugData,
                                         io.netty.channel.ChannelPromise promise)

Sends a GO_AWAY frame to the remote endpoint and updates the connection state appropriately.

onException

void onException(io.netty.channel.ChannelHandlerContext ctx,
               Throwable cause)

Processes the given exception.