Package io.netty.handler.codec.http2
Interface Http2LifecycleManager
-
- All Known Implementing Classes:
Http2ConnectionHandler
,Http2FrameCodec
,Http2MultiplexCodec
,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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
closeStream(Http2Stream stream, ChannelFuture future)
Closes and deactivates the givenstream
.void
closeStreamLocal(Http2Stream stream, ChannelFuture future)
Closes the local side of thestream
.void
closeStreamRemote(Http2Stream stream, ChannelFuture future)
Closes the remote side of thestream
.ChannelFuture
goAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)
Prevents the peer from creating streams and close the connection iferrorCode
is notHttp2Error.NO_ERROR
.void
onError(ChannelHandlerContext ctx, boolean outbound, java.lang.Throwable cause)
Processes the given error.ChannelFuture
resetStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)
Ensure the stream identified bystreamId
is reset.
-
-
-
Method Detail
-
closeStreamLocal
void closeStreamLocal(Http2Stream stream, ChannelFuture future)
Closes the local side of thestream
. Depending on thestream
state this may result instream
being closed. SeecloseStream(Http2Stream, ChannelFuture)
.- Parameters:
stream
- the stream to be half closed.future
- SeecloseStream(Http2Stream, ChannelFuture)
.
-
closeStreamRemote
void closeStreamRemote(Http2Stream stream, ChannelFuture future)
Closes the remote side of thestream
. Depending on thestream
state this may result instream
being closed. SeecloseStream(Http2Stream, ChannelFuture)
.- Parameters:
stream
- the stream to be half closed.future
- SeecloseStream(Http2Stream, ChannelFuture)
.
-
closeStream
void closeStream(Http2Stream stream, ChannelFuture future)
Closes and deactivates the givenstream
. A listener is also attached tofuture
and upon completion the underlying channel will be closed ifHttp2Connection.numActiveStreams()
is 0.- Parameters:
stream
- the stream to be closed and deactivated.future
- when completed ifHttp2Connection.numActiveStreams()
is 0 then the underlying channel will be closed.
-
resetStream
ChannelFuture resetStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)
Ensure the stream identified bystreamId
is reset. If our local state does not indicate the stream has been reset yet then aRST_STREAM
will be sent to the peer. If our local state indicates the stream has already been reset then the return status will indicate success without sending anything to the peer.- Parameters:
ctx
- The context used for communication and buffer allocation if necessary.streamId
- The identifier of the stream to reset.errorCode
- Justification as to why this stream is being reset. SeeHttp2Error
.promise
- Used to indicate the return status of this operation.- Returns:
- Will be considered successful when the connection and stream state has been updated, and a
RST_STREAM
frame has been sent to the peer. If the stream state has already been updated and aRST_STREAM
frame has been sent then the return status may indicate success immediately.
-
goAway
ChannelFuture goAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)
Prevents the peer from creating streams and close the connection iferrorCode
is notHttp2Error.NO_ERROR
. After this call the peer is not allowed to create any new streams and the local endpoint will be limited to creating streams withstream identifier <= lastStreamId
. This may result in sending aGO_AWAY
frame (assuming we have not already sent one withLast-Stream-ID <= lastStreamId
), or may just return success if aGO_AWAY
has previously been sent.- Parameters:
ctx
- The context used for communication and buffer allocation if necessary.lastStreamId
- The last stream that the local endpoint is claiming it will accept.errorCode
- The rational as to why the connection is being closed. SeeHttp2Error
.debugData
- For diagnostic purposes (carries no semantic value).promise
- Used to indicate the return status of this operation.- Returns:
- Will be considered successful when the connection and stream state has been updated, and a
GO_AWAY
frame has been sent to the peer. If the stream state has already been updated and aGO_AWAY
frame has been sent then the return status may indicate success immediately.
-
onError
void onError(ChannelHandlerContext ctx, boolean outbound, java.lang.Throwable cause)
Processes the given error.- Parameters:
ctx
- The context used for communication and buffer allocation if necessary.outbound
-true
if the error was caused by an outbound operation and so the correspondingChannelPromise
was failed as well.cause
- the error.
-
-