io.netty.handler.codec.http2

Class InboundHttp2ToHttpPriorityAdapter

java.lang.Object

io.netty.handler.codec.http2.Http2EventAdapter

io.netty.handler.codec.http2.InboundHttp2ToHttpAdapter

io.netty.handler.codec.http2.InboundHttp2ToHttpPriorityAdapter

All Implemented Interfaces:

Http2Connection.Listener, Http2FrameListener

public final class InboundHttp2ToHttpPriorityAdapter
extends InboundHttp2ToHttpAdapter

Translate header/data/priority HTTP/2 frame events into HTTP events. Just as InboundHttp2ToHttpAdapter may generate multiple FullHttpMessage objects per stream, this class is more likely to generate multiple messages per stream because the chances of an HTTP/2 event happening outside the header/data message flow is more likely.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InboundHttp2ToHttpPriorityAdapter.Builder

Field Summary

Fields inherited from class io.netty.handler.codec.http2.InboundHttp2ToHttpAdapter

connection, messageMap, validateHttpHeaders

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fireChannelRead(ChannelHandlerContext ctx, FullHttpMessage msg, int streamId) Set final headers and fire a channel read event
void	onPriorityRead(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive) Handles an inbound PRIORITY frame.
void	onWeightChanged(Http2Stream stream, short oldWeight) Notifies the listener that the weight has changed for stream
void	priorityTreeParentChanged(Http2Stream stream, Http2Stream oldParent) Notifies the listener that a priority tree parent change has occurred.
protected FullHttpMessage	processHeadersBegin(ChannelHandlerContext ctx, int streamId, 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	removeMessage(int streamId) The streamId is out of scope for the HTTP message flow and will no longer be tracked

Methods inherited from class io.netty.handler.codec.http2.InboundHttp2ToHttpAdapter

newMessage, onDataRead, onHeadersRead, onHeadersRead, onPushPromiseRead, onRstStreamRead, onSettingsRead, streamRemoved

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

goingAway, onGoAwayRead, onPingAckRead, onPingRead, onSettingsAckRead, onUnknownFrame, onWindowUpdateRead, priorityTreeParentChanging, streamActive, streamAdded, streamHalfClosed, streamInactive

Methods inherited from class java.lang.Object

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

Method Detail

removeMessage

protected void removeMessage(int streamId)

Description copied from class: InboundHttp2ToHttpAdapter

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

Overrides:

removeMessage in class InboundHttp2ToHttpAdapter

Parameters:

streamId - The stream id to remove associated state with

fireChannelRead

protected void fireChannelRead(ChannelHandlerContext ctx,
                   FullHttpMessage msg,
                   int streamId)

Description copied from class: InboundHttp2ToHttpAdapter

Set final headers and fire a channel read event

Overrides:

fireChannelRead in class InboundHttp2ToHttpAdapter

Parameters:

ctx - The context to fire the event on

msg - The message to send

streamId - the streamId of the message which is being fired

processHeadersBegin

protected FullHttpMessage processHeadersBegin(ChannelHandlerContext ctx,
                                  int streamId,
                                  Http2Headers headers,
                                  boolean endOfStream,
                                  boolean allowAppend,
                                  boolean appendToTrailer)
                                       throws Http2Exception

Description copied from class: InboundHttp2ToHttpAdapter

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

Overrides:

processHeadersBegin in class InboundHttp2ToHttpAdapter

Parameters:

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

streamId - The stream id the headers apply to

headers - The headers to process

endOfStream - true if the streamId 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 streamId 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 streamId. 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

priorityTreeParentChanged

public void priorityTreeParentChanged(Http2Stream stream,
                             Http2Stream oldParent)

Description copied from interface: Http2Connection.Listener

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.

Specified by:

priorityTreeParentChanged in interface Http2Connection.Listener

Overrides:

priorityTreeParentChanged in class Http2EventAdapter

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)

onWeightChanged

public void onWeightChanged(Http2Stream stream,
                   short oldWeight)

Description copied from interface: Http2Connection.Listener

Notifies the listener that the weight has changed for stream

Specified by:

onWeightChanged in interface Http2Connection.Listener

Overrides:

onWeightChanged in class Http2EventAdapter

Parameters:

stream - The stream which the weight has changed

oldWeight - The old weight for stream

onPriorityRead

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

Description copied from interface: Http2FrameListener

Handles an inbound PRIORITY frame.

Specified by:

onPriorityRead in interface Http2FrameListener

Overrides:

onPriorityRead in class Http2EventAdapter

Parameters:

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

streamId - the subject stream for the frame.

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.

Throws:

Http2Exception