Modifier and Type	Class and Description
pack-priv static interface	Http2Parser.Input Interface that must be implemented by the source of data for the parser.
pack-priv static interface	Http2Parser.Output Interface that must be implemented to receive notifications from the parser as it processes incoming frames.

Modifier and Type	Field and Description
pack-priv static final byte[]	CLIENT_PREFACE_START
protected final String	connectionId
private final byte[]	frameHeaderBuffer
private volatile ByteBuffer	headerReadBuffer
private volatile int	headersCurrentStream
private volatile boolean	headersEndStream
private volatile HpackDecoder	hpackDecoder
protected final Http2Parser.Input	input
protected static final Log	log
private final Http2Parser.Output	output
protected static final StringManager	sm

Access	Constructor and Description
pack-priv	Http2Parser(String connectionId, Http2Parser.Input input, Http2Parser.Output output)

Method Summary

Modifier and Type	Method and Description
protected void	onHeadersComplete(int streamId)
pack-priv void	readConnectionPreface(WebConnection The connection webConnection, Stream The current stream stream) Read and validate the connection preface from input using blocking IO.
protected void	readContinuationFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer)
protected void	readDataFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer)
pack-priv boolean	Returns: `true` if a frame was read otherwise `false` readFrame(boolean Should this method block until a frame is available if no frame is available immediately? block) Deprecated Unused. Will be removed in Tomcat 11 onwards. Read and process a single frame.
pack-priv boolean	Returns: `true` if a frame was read otherwise `false` readFrame() Read and process a single frame.
protected boolean	readFrame(boolean block, FrameType expected)
protected void	readGoawayFrame(int payloadSize, ByteBuffer buffer)
protected void	readHeaderPayload(int streamId, int payloadSize, ByteBuffer buffer)
protected void	readHeadersFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer)
protected void	readPingFrame(int flags, ByteBuffer buffer)
protected void	readPriorityFrame(int streamId, ByteBuffer buffer)
protected void	readPriorityUpdateFrame(int payloadSize, ByteBuffer buffer)
protected void	readPushPromiseFrame(int The pushed stream streamId, int The flags set in the frame header flags, int The size of the payload in bytes payloadSize, ByteBuffer The payload, if available buffer) This default server side implementation always throws an exception.
protected void	readRstFrame(int streamId, ByteBuffer buffer)
protected void	readSettingsFrame(int flags, int payloadSize, ByteBuffer buffer)
protected void	readUnknownFrame(int streamId, int frameTypeId, int flags, int payloadSize, ByteBuffer buffer)
protected void	readWindowUpdateFrame(int streamId, ByteBuffer buffer)
protected void	swallowPayload(int Stream being swallowed streamId, int Type of HTTP/2 frame for which the bytes will be swallowed frameTypeId, int Number of bytes to swallow len, boolean Are the bytes to be swallowed padding bytes? isPadding, ByteBuffer Used with `Http2AsyncParser` to access the data that has already been read byteBuffer) Swallow some or all of the bytes from the payload of an HTTP/2 frame.
protected void	validateFrame(FrameType expected, FrameType frameType, int streamId, int flags, int payloadSize)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CLIENT_PREFACE_START	back to summary
pack-priv static final byte[] CLIENT_PREFACE_START

connectionId	back to summary
protected final String connectionId

frameHeaderBuffer	back to summary
private final byte[] frameHeaderBuffer

headerReadBuffer	back to summary
private volatile ByteBuffer headerReadBuffer

headersCurrentStream	back to summary
private volatile int headersCurrentStream

headersEndStream	back to summary
private volatile boolean headersEndStream

hpackDecoder	back to summary
private volatile HpackDecoder hpackDecoder

input	back to summary
protected final Http2Parser.Input input

log	back to summary
protected static final Log log

output	back to summary
private final Http2Parser.Output output

sm	back to summary
protected static final StringManager sm

Constructor Detail

Http2Parser	back to summary
pack-priv Http2Parser(String connectionId, Http2Parser.Input input, Http2Parser.Output output)

Method Detail

onHeadersComplete	back to summary
protected void onHeadersComplete(int streamId) throws Http2Exception

readConnectionPreface	back to summary
pack-priv void readConnectionPreface(WebConnection webConnection, Stream stream) throws Http2Exception Read and validate the connection preface from input using blocking IO. Parameters webConnection:WebConnection The connection stream:Stream The current stream

readConnectionPreface

back to summary

pack-priv void readConnectionPreface(WebConnection webConnection, Stream stream) throws Http2Exception

Read and validate the connection preface from input using blocking IO.

Parameters

webConnection:WebConnection: The connection
stream:Stream: The current stream

readContinuationFrame	back to summary
protected void readContinuationFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readDataFrame	back to summary
protected void readDataFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readFrame back to summary

readFrame	back to summary
pack-priv boolean readFrame(boolean block) throws Http2Exception, IOException Deprecated Unused. Will be removed in Tomcat 11 onwards. Read and process a single frame. Once the start of a frame is read, the remainder will be read using blocking IO. Parameters block:boolean Should this method block until a frame is available if no frame is available immediately? Returns:boolean `true` if a frame was read otherwise `false` Annotations @Deprecated Exceptions IOException: If an IO error occurs while trying to read a frame

pack-priv boolean readFrame(boolean block) throws Http2Exception, IOException

Deprecated

Unused. Will be removed in Tomcat 11 onwards.

Read and process a single frame. Once the start of a frame is read, the remainder will be read using blocking IO.

Parameters

block:boolean: Should this method block until a frame is available if no frame is available immediately?

Returns:boolean

true if a frame was read otherwise false

Annotations

@Deprecated

Exceptions

IOException:: If an IO error occurs while trying to read a frame

readFrame back to summary

readFrame	back to summary
pack-priv boolean readFrame() throws Http2Exception, IOException Read and process a single frame. The initial read is non-blocking to determine if a frame is present. Once the start of a frame is read, the remainder will be read using blocking IO. Returns:boolean `true` if a frame was read otherwise `false` Exceptions IOException: If an IO error occurs while trying to read a frame

pack-priv boolean readFrame() throws Http2Exception, IOException

Read and process a single frame. The initial read is non-blocking to determine if a frame is present. Once the start of a frame is read, the remainder will be read using blocking IO.

Returns:boolean

true if a frame was read otherwise false

Exceptions

IOException:: If an IO error occurs while trying to read a frame

readFrame	back to summary
protected boolean readFrame(boolean block, FrameType expected) throws IOException, Http2Exception

readGoawayFrame	back to summary
protected void readGoawayFrame(int payloadSize, ByteBuffer buffer) throws IOException

readHeaderPayload	back to summary
protected void readHeaderPayload(int streamId, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readHeadersFrame	back to summary
protected void readHeadersFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readPingFrame	back to summary
protected void readPingFrame(int flags, ByteBuffer buffer) throws IOException

readPriorityFrame	back to summary
protected void readPriorityFrame(int streamId, ByteBuffer buffer) throws IOException

readPriorityUpdateFrame	back to summary
protected void readPriorityUpdateFrame(int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readPushPromiseFrame	back to summary
protected void readPushPromiseFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException This default server side implementation always throws an exception. If re-used for client side parsing, this method should be overridden with an appropriate implementation. Parameters streamId:int The pushed stream flags:int The flags set in the frame header payloadSize:int The size of the payload in bytes buffer:ByteBuffer The payload, if available Exceptions Http2Exception: Always IOException: May be thrown by sub-classes that parse this frame

readPushPromiseFrame

back to summary

protected void readPushPromiseFrame(int streamId, int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

This default server side implementation always throws an exception. If re-used for client side parsing, this method should be overridden with an appropriate implementation.

Parameters

streamId:int: The pushed stream
flags:int: The flags set in the frame header
payloadSize:int: The size of the payload in bytes
buffer:ByteBuffer: The payload, if available

Exceptions

Http2Exception:: Always
IOException:: May be thrown by sub-classes that parse this frame

readRstFrame	back to summary
protected void readRstFrame(int streamId, ByteBuffer buffer) throws Http2Exception, IOException

readSettingsFrame	back to summary
protected void readSettingsFrame(int flags, int payloadSize, ByteBuffer buffer) throws Http2Exception, IOException

readUnknownFrame	back to summary
protected void readUnknownFrame(int streamId, int frameTypeId, int flags, int payloadSize, ByteBuffer buffer) throws IOException

readWindowUpdateFrame	back to summary
protected void readWindowUpdateFrame(int streamId, ByteBuffer buffer) throws Http2Exception, IOException

swallowPayload back to summary

swallowPayload	back to summary
protected void swallowPayload(int streamId, int frameTypeId, int len, boolean isPadding, ByteBuffer byteBuffer) throws IOException, ConnectionException Swallow some or all of the bytes from the payload of an HTTP/2 frame. Parameters streamId:int Stream being swallowed frameTypeId:int Type of HTTP/2 frame for which the bytes will be swallowed len:int Number of bytes to swallow isPadding:boolean Are the bytes to be swallowed padding bytes? byteBuffer:ByteBuffer Used with `Http2AsyncParser` to access the data that has already been read Exceptions IOException: If an I/O error occurs reading additional bytes into the input buffer. ConnectionException: If the swallowed bytes are expected to have a value of zero but do not

protected void swallowPayload(int streamId, int frameTypeId, int len, boolean isPadding, ByteBuffer byteBuffer) throws IOException, ConnectionException

Swallow some or all of the bytes from the payload of an HTTP/2 frame.

Parameters

streamId:int: Stream being swallowed
frameTypeId:int: Type of HTTP/2 frame for which the bytes will be swallowed
len:int: Number of bytes to swallow
isPadding:boolean: Are the bytes to be swallowed padding bytes?
byteBuffer:ByteBuffer: Used with Http2AsyncParser to access the data that has already been read

Exceptions

IOException:: If an I/O error occurs reading additional bytes into the input buffer.
ConnectionException:: If the swallowed bytes are expected to have a value of zero but do not

validateFrame	back to summary
protected void validateFrame(FrameType expected, FrameType frameType, int streamId, int flags, int payloadSize) throws Http2Exception

org.apache.coyote.http2 back to summary

pack-priv Interface Http2Parser.Input

Known Direct Implementers: org.apache.coyote.http2.Http2UpgradeHandler

Interface that must be implemented by the source of data for the parser.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the buffer was filled otherwise `false` fill(boolean Should the first read into the provided buffer be a blocking read or not. block, byte[] Buffer to fill data, int Position in buffer to start writing offset, int Number of bytes to read length) Fill the given array with data unless non-blocking is requested and no data is available.
public default boolean	fill(boolean block, byte[] data)
public default boolean	fill(boolean block, ByteBuffer data, int len)
public int	getMaxFrameSize()

Method Detail

fill back to summary

fill	back to summary
public boolean fill(boolean block, byte[] data, int offset, int length) throws IOException Fill the given array with data unless non-blocking is requested and no data is available. If any data is available then the buffer will be filled using blocking I/O. Parameters block:boolean Should the first read into the provided buffer be a blocking read or not. data:byte[] Buffer to fill offset:int Position in buffer to start writing length:int Number of bytes to read Returns:boolean `true` if the buffer was filled otherwise `false` Exceptions IOException: If an I/O occurred while obtaining data with which to fill the buffer

public boolean fill(boolean block, byte[] data, int offset, int length) throws IOException

Fill the given array with data unless non-blocking is requested and no data is available. If any data is available then the buffer will be filled using blocking I/O.

Parameters

block:boolean: Should the first read into the provided buffer be a blocking read or not.
data:byte[]: Buffer to fill
offset:int: Position in buffer to start writing
length:int: Number of bytes to read

Returns:boolean

true if the buffer was filled otherwise false

Exceptions

IOException:: If an I/O occurred while obtaining data with which to fill the buffer

fill	back to summary
public default boolean fill(boolean block, byte[] data) throws IOException

fill	back to summary
public default boolean fill(boolean block, ByteBuffer data, int len) throws IOException

getMaxFrameSize	back to summary
public int getMaxFrameSize()

org.apache.coyote.http2 back to summary

pack-priv Interface Http2Parser.Output

Known Direct Implementers: org.apache.coyote.http2.Http2UpgradeHandler

Interface that must be implemented to receive notifications from the parser as it processes incoming frames.

Method Summary

Modifier and Type	Method and Description
public void	endRequestBodyFrame(int streamId, int dataLength)
public HpackDecoder	getHpackDecoder()
public void	goaway(int lastStreamId, long errorCode, String debugData)
public void	headersContinue(int payloadSize, boolean endOfHeaders)
public void	headersEnd(int streamId, boolean endOfStream)
public HpackDecoder.HeaderEmitter	headersStart(int streamId, boolean headersEndStream)
public void	increaseOverheadCount(FrameType frameType)
public void	incrementWindowSize(int streamId, int increment)
public void	onSwallowedDataFramePayload(int The stream on which the payload that has been swallowed was received streamId, int The number of bytes that the parser swallowed. swallowedDataBytesCount) Notification triggered when the parser swallows some or all of a DATA frame payload without writing it to the ByteBuffer returned by `startRequestBodyFrame(int, int, boolean)`.
public void	onSwallowedUnknownFrame(int The stream on which the swallowed frame was received streamId, int The (unrecognised) type of swallowed frame frameTypeId, int The flags set in the header of the swallowed frame flags, int The payload size of the swallowed frame size) Notification triggered when the parser swallows the payload of an unknown frame.
public void	pingReceive(byte[] payload, boolean ack)
public void	priorityUpdate(int prioritizedStreamID, Priority p)
public void	receivedEndOfStream(int streamId)
public void	reset(int streamId, long errorCode)
public void	setting(Setting setting, long value)
public void	settingsEnd(boolean ack)
public ByteBuffer	startRequestBodyFrame(int streamId, int payloadSize, boolean endOfStream)

Method Detail

endRequestBodyFrame	back to summary
public void endRequestBodyFrame(int streamId, int dataLength) throws Http2Exception, IOException

getHpackDecoder	back to summary
public HpackDecoder getHpackDecoder()

goaway	back to summary
public void goaway(int lastStreamId, long errorCode, String debugData)

headersContinue	back to summary
public void headersContinue(int payloadSize, boolean endOfHeaders)

headersEnd	back to summary
public void headersEnd(int streamId, boolean endOfStream) throws Http2Exception

headersStart	back to summary
public HpackDecoder.HeaderEmitter headersStart(int streamId, boolean headersEndStream) throws Http2Exception, IOException

increaseOverheadCount	back to summary
public void increaseOverheadCount(FrameType frameType)

incrementWindowSize	back to summary
public void incrementWindowSize(int streamId, int increment) throws Http2Exception

onSwallowedDataFramePayload back to summary

public void onSwallowedDataFramePayload(int streamId, int swallowedDataBytesCount) throws ConnectionException, IOException

Notification triggered when the parser swallows some or all of a DATA frame payload without writing it to the ByteBuffer returned by startRequestBodyFrame(int, int, boolean).

Parameters

streamId:int: The stream on which the payload that has been swallowed was received
swallowedDataBytesCount:int: The number of bytes that the parser swallowed.

Exceptions

ConnectionException:: If an error fatal to the HTTP/2 connection occurs while swallowing the payload
IOException:: If an I/O occurred while swallowing the payload

onSwallowedUnknownFrame

back to summary

public void onSwallowedUnknownFrame(int streamId, int frameTypeId, int flags, int size) throws IOException

Notification triggered when the parser swallows the payload of an unknown frame.

Parameters

streamId:int: The stream on which the swallowed frame was received
frameTypeId:int: The (unrecognised) type of swallowed frame
flags:int: The flags set in the header of the swallowed frame
size:int: The payload size of the swallowed frame

Exceptions

IOException:: If an I/O occurred while swallowing the unknown frame

pingReceive	back to summary
public void pingReceive(byte[] payload, boolean ack) throws IOException

priorityUpdate	back to summary
public void priorityUpdate(int prioritizedStreamID, Priority p) throws Http2Exception

receivedEndOfStream	back to summary
public void receivedEndOfStream(int streamId) throws ConnectionException

reset	back to summary
public void reset(int streamId, long errorCode) throws Http2Exception

setting	back to summary
public void setting(Setting setting, long value) throws ConnectionException

settingsEnd	back to summary
public void settingsEnd(boolean ack) throws IOException

startRequestBodyFrame	back to summary
public ByteBuffer startRequestBodyFrame(int streamId, int payloadSize, boolean endOfStream) throws Http2Exception

pack-priv Class Http2Parser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface Http2Parser.Input

Method Summary

Method Detail

pack-priv Interface Http2Parser.Output

Method Summary

Method Detail