Netty5/Codec/HTTP2 5.0.0.Alpha5 · io.netty5.handler.codec.http2.Http2EmptyDataFrameListener

Modifier and Type	Field and Description
private int	emptyDataFrames
private final int	maxConsecutiveEmptyFrames
private boolean	violationDetected

Access	Constructor and Description
pack-priv	Http2EmptyDataFrameListener(Http2FrameListener listener, int maxConsecutiveEmptyFrames)

Method Summary

Modifier and Type	Method and Description
public int	onDataRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the subject stream for the frame. streamId, Buffer payload buffer for the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call). data, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. endOfStream) Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onDataRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onDataRead. Handles an inbound `DATA` frame.
public void	onHeadersRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the subject stream for the frame. streamId, Http2Headers the received headers. headers, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. endStream) Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Handles an inbound `HEADERS` frame.
public void	onHeadersRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the subject stream for the frame. streamId, Http2Headers the received headers. headers, int the stream on which this stream depends, or 0 if dependent on the connection. streamDependency, short the new weight for the stream. weight, boolean whether or not the stream should be the exclusive dependent of its parent. exclusive, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. endStream) Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Handles an inbound `HEADERS` frame with priority information specified.

Inherited from io.netty5.handler.codec.http2.Http2FrameListenerDecorator:: onGoAwayRead onPingAckRead onPingRead onPriorityRead onPushPromiseRead onRstStreamRead onSettingsAckRead onSettingsRead onUnknownFrame onWindowUpdateRead

emptyDataFrames	back to summary
private int emptyDataFrames

maxConsecutiveEmptyFrames	back to summary
private final int maxConsecutiveEmptyFrames

violationDetected	back to summary
private boolean violationDetected

Http2EmptyDataFrameListener	back to summary
pack-priv Http2EmptyDataFrameListener(Http2FrameListener listener, int maxConsecutiveEmptyFrames)

Method Detail

onDataRead back to summary

onDataRead	back to summary
public int onDataRead(ChannelHandlerContext ctx, int streamId, Buffer data, int padding, boolean endOfStream) throws Http2Exception Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onDataRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onDataRead. Doc from io.netty5.handler.codec.http2.Http2FrameListener.onDataRead. Handles an inbound `DATA` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the subject stream for the frame. data:Buffer payload buffer for the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call). padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endOfStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. Returns:int the number of bytes that have been processed by the application. The returned bytes are used by the inbound flow controller to determine the appropriate time to expand the inbound flow control window (i.e. send `WINDOW_UPDATE`). Returning a value equal to the length of `data` + `padding` will effectively opt-out of application-level flow control for this frame. Returning a value less than the length of `data` + `padding` will defer the returning of the processed bytes, which the application must later return via `Http2LocalFlowController#consumeBytes(Http2Stream, int)`. The returned value must be >= `0` and <= `data.readableBytes()` + `padding`. Annotations @Override

public int onDataRead(ChannelHandlerContext ctx, int streamId, Buffer data, int padding, boolean endOfStream) throws Http2Exception

Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onDataRead.

Implements io.netty5.handler.codec.http2.Http2FrameListener.onDataRead.

Doc from io.netty5.handler.codec.http2.Http2FrameListener.onDataRead.

Handles an inbound DATA frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the subject stream for the frame.
data:Buffer: payload buffer for the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call).
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endOfStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Returns:int

the number of bytes that have been processed by the application. The returned bytes are used by the inbound flow controller to determine the appropriate time to expand the inbound flow control window (i.e. send WINDOW_UPDATE). Returning a value equal to the length of data + padding will effectively opt-out of application-level flow control for this frame. Returning a value less than the length of data + padding will defer the returning of the processed bytes, which the application must later return via Http2LocalFlowController#consumeBytes(Http2Stream, int). The returned value must be >= 0 and <= data.readableBytes() + padding.

Annotations

@Override

onHeadersRead back to summary

onHeadersRead	back to summary
public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream) throws Http2Exception Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Doc from io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Handles an inbound `HEADERS` frame. Only one of the following methods will be called for each `HEADERS` frame sequence. One will be called when the `END_HEADERS` flag has been received. `onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)` `onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)` `onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)` To say it another way; the `Http2Headers` will contain all of the headers for the current message exchange step (additional queuing is not necessary). Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the subject stream for the frame. headers:Http2Headers the received headers. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. Annotations @Override

public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream) throws Http2Exception

Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead.

Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead.

Doc from io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead.

Handles an inbound HEADERS frame.

Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.

To say it another way; the Http2Headers will contain all of the headers for the current message exchange step (additional queuing is not necessary).

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the subject stream for the frame.
headers:Http2Headers: the received headers.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Annotations

@Override

onHeadersRead back to summary

onHeadersRead	back to summary
public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream) throws Http2Exception Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead. Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Doc from io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead. Handles an inbound `HEADERS` frame with priority information specified. Only called if `END_HEADERS` encountered. Only one of the following methods will be called for each `HEADERS` frame sequence. One will be called when the `END_HEADERS` flag has been received. `onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)` `onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)` `onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)` To say it another way; the `Http2Headers` will contain all of the headers for the current message exchange step (additional queuing is not necessary). Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the subject stream for the frame. headers:Http2Headers the received headers. streamDependency:int the stream on which this stream depends, or 0 if dependent on the connection. weight:short the new weight for the stream. exclusive:boolean whether or not the stream should be the exclusive dependent of its parent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. Annotations @Override

public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream) throws Http2Exception

Overrides io.netty5.handler.codec.http2.Http2FrameListenerDecorator.onHeadersRead.

Implements io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead.

Doc from io.netty5.handler.codec.http2.Http2FrameListener.onHeadersRead.

Handles an inbound HEADERS frame with priority information specified. Only called if END_HEADERS encountered.

Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.

To say it another way; the Http2Headers will contain all of the headers for the current message exchange step (additional queuing is not necessary).

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the subject stream for the frame.
headers:Http2Headers: the received headers.
streamDependency:int: the stream on which this stream depends, or 0 if dependent on the connection.
weight:short: the new weight for the stream.
exclusive:boolean: whether or not the stream should be the exclusive dependent of its parent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Annotations

@Override

pack-priv final Class Http2EmptyDataFrameListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail