io.netty.handler.codec.http2

Interface Http2Connection.Listener

All Known Implementing Classes:

Http2ConnectionAdapter, Http2EventAdapter, InboundHttp2ToHttpAdapter, InboundHttp2ToHttpPriorityAdapter

Enclosing interface:

Http2Connection

public static interface Http2Connection.Listener

Listener for life-cycle events for streams in this connection.

Method Summary

Methods

Modifier and Type	Method and Description
void	onGoAwayReceived(int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData) Called when a GOAWAY was received from the remote endpoint.
void	onGoAwaySent(int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData) Called when a GOAWAY frame was sent for the connection.
void	onPriorityTreeParentChanged(Http2Stream stream, Http2Stream oldParent) Notifies the listener that a priority tree parent change has occurred.
void	onPriorityTreeParentChanging(Http2Stream stream, Http2Stream newParent) Notifies the listener that a parent dependency is about to change This is called while the tree is being restructured and so the tree structure is not necessarily steady state.
void	onStreamActive(Http2Stream stream) Notifies the listener that the given stream was made active (i.e.
void	onStreamAdded(Http2Stream stream) Notifies the listener that the given stream was added to the connection.
void	onStreamClosed(Http2Stream stream) Notifies the listener that the given stream is now CLOSED in both directions and will no longer be accessible via Http2Connection.forEachActiveStream(Http2StreamVisitor).
void	onStreamHalfClosed(Http2Stream stream) Notifies the listener that the given stream has transitioned from OPEN to HALF CLOSED.
void	onStreamRemoved(Http2Stream stream) Notifies the listener that the given stream has now been removed from the connection and will no longer be returned via Http2Connection.stream(int).
void	onWeightChanged(Http2Stream stream, short oldWeight) Notifies the listener that the weight has changed for stream.

Method Detail

onStreamAdded

void onStreamAdded(Http2Stream stream)

Notifies the listener that the given stream was added to the connection. This stream may not yet be active (i.e. OPEN or HALF CLOSED).

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

onStreamActive

void onStreamActive(Http2Stream stream)

Notifies the listener that the given stream was made active (i.e. OPEN or HALF CLOSED).

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

onStreamHalfClosed

void onStreamHalfClosed(Http2Stream stream)

Notifies the listener that the given stream has transitioned from OPEN to HALF CLOSED. This method will not be called until a state transition occurs from when onStreamActive(Http2Stream) was called. The stream can be inspected to determine which side is HALF CLOSED.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

onStreamClosed

void onStreamClosed(Http2Stream stream)

Notifies the listener that the given stream is now CLOSED in both directions and will no longer be accessible via Http2Connection.forEachActiveStream(Http2StreamVisitor).

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

onStreamRemoved

void onStreamRemoved(Http2Stream stream)

Notifies the listener that the given stream has now been removed from the connection and will no longer be returned via Http2Connection.stream(int). The connection may maintain inactive streams for some time before removing them.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

onPriorityTreeParentChanged

void onPriorityTreeParentChanged(Http2Stream stream,
                               Http2Stream oldParent)

Notifies the listener that a priority tree parent change has occurred. This method will be invoked in a top down order relative to the priority tree. This method will also be invoked after all tree structure changes have been made and the tree is in steady state relative to the priority change which caused the tree structure to change.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

Parameters:

stream - The stream which had a parent change (new parent and children will be steady state)

oldParent - The old parent which stream used to be a child of (may be null)

onPriorityTreeParentChanging

void onPriorityTreeParentChanging(Http2Stream stream,
                                Http2Stream newParent)

Notifies the listener that a parent dependency is about to change This is called while the tree is being restructured and so the tree structure is not necessarily steady state.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

Parameters:

stream - The stream which the parent is about to change to newParent

newParent - The stream which will be the parent of stream

onWeightChanged

void onWeightChanged(Http2Stream stream,
                   short oldWeight)

Notifies the listener that the weight has changed for stream.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

Parameters:

stream - The stream which the weight has changed

oldWeight - The old weight for stream

onGoAwaySent

void onGoAwaySent(int lastStreamId,
                long errorCode,
                io.netty.buffer.ByteBuf debugData)

Called when a GOAWAY frame was sent for the connection.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

Parameters:

lastStreamId - the last known stream of the remote endpoint.

errorCode - the error code, if abnormal closure.

debugData - application-defined debug data.

onGoAwayReceived

void onGoAwayReceived(int lastStreamId,
                    long errorCode,
                    io.netty.buffer.ByteBuf debugData)

Called when a GOAWAY was received from the remote endpoint. This event handler duplicates Http2FrameListener.onGoAwayRead(io.netty.channel.ChannelHandlerContext, int, long, io.netty.buffer.ByteBuf) but is added here in order to simplify application logic for handling GOAWAY in a uniform way. An application should generally not handle both events, but if it does this method is called second, after notifying the Http2FrameListener.

If a RuntimeException is thrown it will be logged and not propagated. Throwing from this method is not supported and is considered a programming error.

Parameters:

lastStreamId - the last known stream of the remote endpoint.

errorCode - the error code, if abnormal closure.

debugData - application-defined debug data.