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

Method Summary

Modifier and Type	Method and Description
public int	Returns: 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`. 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) Handles an inbound `DATA` frame.
public void	onGoAwayRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the last known stream of the remote endpoint. lastStreamId, long the error code, if abnormal closure. errorCode, Buffer application-defined debug data. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call). debugData) Handles an inbound `GO_AWAY` 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. endOfStream) 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. endOfStream) Handles an inbound `HEADERS` frame with priority information specified.
public void	onPingAckRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, long the payload of the frame. data) Handles an inbound `PING` acknowledgment.
public void	onPingRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, long the payload of the frame. data) Handles an inbound `PING` frame.
public void	onPriorityRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the subject stream for the frame. streamId, 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) Handles an inbound `PRIORITY` frame.
public void	onPushPromiseRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the stream the frame was sent on. streamId, int the ID of the promised stream. promisedStreamId, 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) Handles an inbound `PUSH_PROMISE` frame.
public void	onRstStreamRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the stream that is terminating. streamId, long the error code identifying the type of failure. errorCode) Handles an inbound `RST_STREAM` frame.
public void	onSettingsAckRead(ChannelHandlerContext the context from the handler where the frame was read. ctx) Handles an inbound `SETTINGS` acknowledgment frame.
public void	onSettingsRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, Http2Settings the settings received from the remote endpoint. settings) Handles an inbound `SETTINGS` frame.
public void	onUnknownFrame(ChannelHandlerContext the context from the handler where the frame was read. ctx, byte the frame type from the HTTP/2 header. frameType, int the stream the frame was sent on. streamId, Http2Flags the flags in the frame header. flags, Buffer the payload of the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call). payload) Handler for a frame not defined by the HTTP/2 spec.
public void	onWindowUpdateRead(ChannelHandlerContext the context from the handler where the frame was read. ctx, int the stream the frame was sent on. streamId, int the increased number of bytes of the remote endpoint's flow control window. windowSizeIncrement) Handles an inbound `WINDOW_UPDATE` frame.

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 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`.

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

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.

onGoAwayRead back to summary

onGoAwayRead	back to summary
public void onGoAwayRead(ChannelHandlerContext ctx, int lastStreamId, long errorCode, Buffer debugData) throws Http2Exception Handles an inbound `GO_AWAY` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. lastStreamId:int the last known stream of the remote endpoint. errorCode:long the error code, if abnormal closure. debugData:Buffer application-defined debug data. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call).

public void onGoAwayRead(ChannelHandlerContext ctx, int lastStreamId, long errorCode, Buffer debugData) throws Http2Exception

Handles an inbound GO_AWAY frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
lastStreamId:int: the last known stream of the remote endpoint.
errorCode:long: the error code, if abnormal closure.
debugData:Buffer: application-defined debug data. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call).

onHeadersRead back to summary

onHeadersRead	back to summary
public void onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endOfStream) throws Http2Exception 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). endOfStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

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

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).
endOfStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

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 endOfStream) throws Http2Exception 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). endOfStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

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

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).
endOfStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

onPingAckRead back to summary

onPingAckRead	back to summary
public void onPingAckRead(ChannelHandlerContext ctx, long data) throws Http2Exception Handles an inbound `PING` acknowledgment. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. data:long the payload of the frame.

public void onPingAckRead(ChannelHandlerContext ctx, long data) throws Http2Exception

Handles an inbound PING acknowledgment.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
data:long: the payload of the frame.

onPingRead back to summary

onPingRead	back to summary
public void onPingRead(ChannelHandlerContext ctx, long data) throws Http2Exception Handles an inbound `PING` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. data:long the payload of the frame.

public void onPingRead(ChannelHandlerContext ctx, long data) throws Http2Exception

Handles an inbound PING frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
data:long: the payload of the frame.

onPriorityRead back to summary

onPriorityRead	back to summary
public void onPriorityRead(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive) throws Http2Exception Handles an inbound `PRIORITY` frame. Note that is it possible to have this method called and no stream object exist for either `streamId`, `streamDependency`, or both. This is because the `PRIORITY` frame can be sent/received when streams are in the `CLOSED` state. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the subject stream for the frame. 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.

public void onPriorityRead(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive) throws Http2Exception

Handles an inbound PRIORITY frame.

Note that is it possible to have this method called and no stream object exist for either streamId, streamDependency, or both. This is because the PRIORITY frame can be sent/received when streams are in the CLOSED state.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the subject stream for the frame.
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.

onPushPromiseRead back to summary

onPushPromiseRead	back to summary
public void onPushPromiseRead(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding) throws Http2Exception Handles an inbound `PUSH_PROMISE` frame. Only called if `END_HEADERS` encountered. Promised requests MUST be authoritative, cacheable, and safe. See [RFC 7540], Section 8.2. 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 stream the frame was sent on. promisedStreamId:int the ID of the promised stream. 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).

public void onPushPromiseRead(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding) throws Http2Exception

Handles an inbound PUSH_PROMISE frame. Only called if END_HEADERS encountered.

Promised requests MUST be authoritative, cacheable, and safe. See [RFC 7540], Section 8.2.

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 stream the frame was sent on.
promisedStreamId:int: the ID of the promised stream.
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).

onRstStreamRead back to summary

onRstStreamRead	back to summary
public void onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) throws Http2Exception Handles an inbound `RST_STREAM` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the stream that is terminating. errorCode:long the error code identifying the type of failure.

public void onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) throws Http2Exception

Handles an inbound RST_STREAM frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the stream that is terminating.
errorCode:long: the error code identifying the type of failure.

onSettingsAckRead back to summary

onSettingsAckRead	back to summary
public void onSettingsAckRead(ChannelHandlerContext ctx) throws Http2Exception Handles an inbound `SETTINGS` acknowledgment frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read.

public void onSettingsAckRead(ChannelHandlerContext ctx) throws Http2Exception

Handles an inbound SETTINGS acknowledgment frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.

onSettingsRead back to summary

onSettingsRead	back to summary
public void onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings) throws Http2Exception Handles an inbound `SETTINGS` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. settings:Http2Settings the settings received from the remote endpoint.

public void onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings) throws Http2Exception

Handles an inbound SETTINGS frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
settings:Http2Settings: the settings received from the remote endpoint.

onUnknownFrame	back to summary
public void onUnknownFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, Buffer payload) throws Http2Exception Handler for a frame not defined by the HTTP/2 spec. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. frameType:byte the frame type from the HTTP/2 header. streamId:int the stream the frame was sent on. flags:Http2Flags the flags in the frame header. payload:Buffer the payload of the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call).

onUnknownFrame

back to summary

public void onUnknownFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, Buffer payload) throws Http2Exception

Handler for a frame not defined by the HTTP/2 spec.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
frameType:byte: the frame type from the HTTP/2 header.
streamId:int: the stream the frame was sent on.
flags:Http2Flags: the flags in the frame header.
payload:Buffer: the payload of the frame. This buffer will be closed by the codec when the method returns (the buffer will be inaccessible after the method call).

onWindowUpdateRead back to summary

onWindowUpdateRead	back to summary
public void onWindowUpdateRead(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement) throws Http2Exception Handles an inbound `WINDOW_UPDATE` frame. Parameters ctx:ChannelHandlerContext the context from the handler where the frame was read. streamId:int the stream the frame was sent on. windowSizeIncrement:int the increased number of bytes of the remote endpoint's flow control window.

public void onWindowUpdateRead(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement) throws Http2Exception

Handles an inbound WINDOW_UPDATE frame.

Parameters

ctx:ChannelHandlerContext: the context from the handler where the frame was read.
streamId:int: the stream the frame was sent on.
windowSizeIncrement:int: the increased number of bytes of the remote endpoint's flow control window.

public Interface Http2FrameListener

Method Summary

Method Detail