Module io.netty.codec.http2

Package io.netty5.handler.codec.http2

Class InboundHttp2ToHttpAdapter

java.lang.Object

io.netty5.handler.codec.http2.Http2EventAdapter

io.netty5.handler.codec.http2.InboundHttp2ToHttpAdapter

All Implemented Interfaces:

Http2Connection.Listener, Http2FrameListener

@UnstableApi
public class InboundHttp2ToHttpAdapter
extends Http2EventAdapter

This adapter provides just header/data events from the HTTP message flow defined in [RFC 7540], Section 8.1.

See HttpToHttp2ConnectionHandler to get translation from HTTP/1.x objects to HTTP/2 frames for writes.

Field Summary

Fields

Modifier and Type	Field	Description
protected Http2Connection	connection
protected boolean	validateHttpHeaders

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InboundHttp2ToHttpAdapter(Http2Connection connection, int maxContentLength, boolean validateHttpHeaders, boolean propagateSettings)

Method Summary

Modifier and Type	Method	Description
protected void	fireChannelRead(ChannelHandlerContext ctx, FullHttpMessage<?> msg, boolean release, Http2Stream stream)	Set final headers and fire a channel read event
protected FullHttpMessage<?>	getMessage(Http2Stream stream)	Get the FullHttpMessage associated with stream.
protected FullHttpMessage<?>	newMessage(Http2Stream stream, Http2Headers headers, boolean validateHttpHeaders, BufferAllocator alloc)	Create a new FullHttpMessage based upon the current connection parameters
int	onDataRead(ChannelHandlerContext ctx, int streamId, Buffer data, int padding, boolean endOfStream)	Handles an inbound DATA frame.
void	onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endOfStream)	Handles an inbound HEADERS frame.
void	onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream)	Handles an inbound HEADERS frame with priority information specified.
void	onPushPromiseRead(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding)	Handles an inbound PUSH_PROMISE frame.
void	onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode)	Handles an inbound RST_STREAM frame.
protected void	onRstStreamRead(Http2Stream stream, FullHttpMessage<?> msg)	Called if a RST_STREAM is received but we have some data for that stream.
void	onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings)	Handles an inbound SETTINGS frame.
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).
protected FullHttpMessage<?>	processHeadersBegin(ChannelHandlerContext ctx, Http2Stream stream, Http2Headers headers, boolean endOfStream, boolean allowAppend, boolean appendToTrailer)	Provides translation between HTTP/2 and HTTP header objects while ensuring the stream is in a valid state for additional headers.
protected void	putMessage(Http2Stream stream, FullHttpMessage<?> message)	Make message be the state associated with stream.
protected void	removeMessage(Http2Stream stream, boolean release)	The stream is out of scope for the HTTP message flow and will no longer be tracked

Methods inherited from class io.netty5.handler.codec.http2.Http2EventAdapter

onGoAwayRead, onGoAwayReceived, onGoAwaySent, onPingAckRead, onPingRead, onPriorityRead, onSettingsAckRead, onStreamActive, onStreamAdded, onStreamClosed, onStreamHalfClosed, onUnknownFrame, onWindowUpdateRead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

connection

protected final Http2Connection connection

validateHttpHeaders

protected final boolean validateHttpHeaders

Constructor Detail

InboundHttp2ToHttpAdapter

protected InboundHttp2ToHttpAdapter(Http2Connection connection,
                                    int maxContentLength,
                                    boolean validateHttpHeaders,
                                    boolean propagateSettings)

Method Detail

removeMessage

protected final void removeMessage(Http2Stream stream,
                                   boolean release)

The stream is out of scope for the HTTP message flow and will no longer be tracked

Parameters:

stream - The stream to remove associated state with

release - true to call release on the value if it is present. false to not call release.

getMessage

protected final FullHttpMessage<?> getMessage(Http2Stream stream)

Get the FullHttpMessage associated with stream.

Parameters:

stream - The stream to get the associated state from

Returns:

The FullHttpMessage associated with stream.

putMessage

protected final void putMessage(Http2Stream stream,
                                FullHttpMessage<?> message)

Make message be the state associated with stream.

Parameters:

stream - The stream which message is associated with.

message - The message which contains the HTTP semantics.

onStreamRemoved

public void onStreamRemoved(Http2Stream stream)

Description copied from interface: Http2Connection.Listener

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.

Specified by:

onStreamRemoved in interface Http2Connection.Listener

Overrides:

onStreamRemoved in class Http2EventAdapter

fireChannelRead

protected void fireChannelRead(ChannelHandlerContext ctx,
                               FullHttpMessage<?> msg,
                               boolean release,
                               Http2Stream stream)

Set final headers and fire a channel read event

Parameters:

ctx - The context to fire the event on

msg - The message to send

release - true to call release on the value if it is present. false to not call release.

stream - the stream of the message which is being fired

newMessage

protected FullHttpMessage<?> newMessage(Http2Stream stream,
                                        Http2Headers headers,
                                        boolean validateHttpHeaders,
                                        BufferAllocator alloc)
                                 throws Http2Exception

Create a new FullHttpMessage based upon the current connection parameters

Parameters:

stream - The stream to create a message for

headers - The headers associated with stream

validateHttpHeaders -

• true to validate HTTP headers in the http-codec
• false not to validate HTTP headers in the http-codec

alloc - The BufferAllocator to use to generate the content of the message

Throws:

Http2Exception - If there is an error when creating FullHttpMessage from Http2Stream and Http2Headers

processHeadersBegin

protected FullHttpMessage<?> processHeadersBegin(ChannelHandlerContext ctx,
                                                 Http2Stream stream,
                                                 Http2Headers headers,
                                                 boolean endOfStream,
                                                 boolean allowAppend,
                                                 boolean appendToTrailer)
                                          throws Http2Exception

Provides translation between HTTP/2 and HTTP header objects while ensuring the stream is in a valid state for additional headers.

Parameters:

ctx - The context for which this message has been received. Used to send informational header if detected.

stream - The stream the headers apply to

headers - The headers to process

endOfStream - true if the stream has received the end of stream flag

allowAppend -

• true if headers will be appended if the stream already exists.
• if false and the stream already exists this method returns null.

appendToTrailer -

• true if a message stream already exists then the headers should be added to the trailing headers.
• false then appends will be done to the initial headers.

Returns:

The object used to track the stream corresponding to stream. null if allowAppend is false and the stream already exists.

Throws:

Http2Exception - If the stream id is not in the correct state to process the headers request

onDataRead

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

Description copied from interface: Http2FrameListener

Handles an inbound DATA frame.

Specified by:

onDataRead in interface Http2FrameListener

Overrides:

onDataRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

data - payload buffer for the frame. This buffer will be released by the codec.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

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.

Throws:

Http2Exception

onHeadersRead

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

Description copied from interface: Http2FrameListener

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.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.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).

Specified by:

onHeadersRead in interface Http2FrameListener

Overrides:

onHeadersRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

headers - the received headers.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Throws:

Http2Exception

onHeadersRead

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

Description copied from interface: Http2FrameListener

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.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.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).

Specified by:

onHeadersRead in interface Http2FrameListener

Overrides:

onHeadersRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

headers - the received headers.

streamDependency - the stream on which this stream depends, or 0 if dependent on the connection.

weight - the new weight for the stream.

exclusive - whether or not the stream should be the exclusive dependent of its parent.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Throws:

Http2Exception

onRstStreamRead

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

Description copied from interface: Http2FrameListener

Handles an inbound RST_STREAM frame.

Specified by:

onRstStreamRead in interface Http2FrameListener

Overrides:

onRstStreamRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

streamId - the stream that is terminating.

errorCode - the error code identifying the type of failure.

Throws:

Http2Exception

onPushPromiseRead

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

Description copied from interface: Http2FrameListener

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.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.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).

Specified by:

onPushPromiseRead in interface Http2FrameListener

Overrides:

onPushPromiseRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

streamId - the stream the frame was sent on.

promisedStreamId - the ID of the promised stream.

headers - the received headers.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

Throws:

Http2Exception

onSettingsRead

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

Description copied from interface: Http2FrameListener

Handles an inbound SETTINGS frame.

Specified by:

onSettingsRead in interface Http2FrameListener

Overrides:

onSettingsRead in class Http2EventAdapter

Parameters:

ctx - the context from the handler where the frame was read.

settings - the settings received from the remote endpoint.

Throws:

Http2Exception

onRstStreamRead

protected void onRstStreamRead(Http2Stream stream,
                               FullHttpMessage<?> msg)

Called if a RST_STREAM is received but we have some data for that stream.