Tomcat 10.1.19 · org.apache.coyote.http2.Http2UpgradeHandler

Modifier and Type	Class and Description
private static enum	Http2UpgradeHandler.ConnectionState
private class	Http2UpgradeHandler.DefaultHeaderFrameBuffers
protected static interface	Http2UpgradeHandler.HeaderFrameBuffers
protected class	Http2UpgradeHandler.PingManager
protected static class	Http2UpgradeHandler.PingRecord

Field Summary

Modifier and Type	Field and Description
protected final AtomicInteger	activeRemoteStreamCount
private final Adapter	adapter
private long	backLogSize
private final Set<Stream>	backLogStreams
protected final String	connectionId
private AtomicReference<Http2UpgradeHandler.ConnectionState>	connectionState
private volatile long	connectionTimeout
protected static final int	FLAG_END_OF_HEADERS
protected static final int	FLAG_END_OF_STREAM
protected static final byte[]	GOAWAY
protected static final HeaderSink	HEADER_SINK
private HpackDecoder	hpackDecoder
private HpackEncoder	hpackEncoder
private static final String	HTTP2_SETTINGS_HEADER
private volatile int	lastNonFinalDataPayload
private volatile int	lastWindowUpdate
protected final ConnectionSettingsLocal	localSettings Local settings are settings defined by Tomcat and sent to the client that the client must use when communicating with Tomcat.
protected static final Log	log Hides org.apache.coyote.http2.AbstractStream.log.
private volatile int	maxActiveRemoteStreamId
private volatile int	maxProcessedStreamId
private volatile int	newStreamsSinceLastPrune
private final AtomicInteger	nextLocalStreamId
private final AtomicLong	overheadCount
private volatile Http2Parser	parser
private volatile long	pausedNanoTime
protected static final byte[]	PING
protected static final byte[]	PING_ACK
private final Http2UpgradeHandler.PingManager	pingManager
protected final Http2Protocol	protocol
private Queue<StreamRunnable>	queuedRunnable
private final ConnectionSettingsRemote	remoteSettings Remote settings are settings defined by the client and sent to Tomcat that Tomcat must use when communicating with the client.
protected static final byte[]	SETTINGS_ACK
protected static final StringManager	sm Hides org.apache.coyote.http2.AbstractStream.sm.
protected final SocketWrapperBase<?>	socketWrapper
private volatile SSLSupport	sslSupport
private static final Integer	STREAM_ID_ZERO
private AtomicInteger	streamConcurrency
private final ConcurrentNavigableMap<Integer, AbstractNonZeroStream>	streams
protected final UserDataHelper	userDataHelper

Inherited from org.apache.coyote.http2.AbstractStream:: windowAllocationAvailable windowAllocationLock

Access	Constructor and Description
pack-priv	Http2UpgradeHandler(Http2Protocol protocol, Adapter adapter, Request coyoteRequest, SocketWrapperBase<?> socketWrapper)

Method Summary

Modifier and Type	Method and Description
private int	allocate(AbstractStream stream, int allocation)
pack-priv void	checkPauseState()
private void	close()
pack-priv void	closeConnection(Http2Exception ce)
private void	closeIdleStreams(int newMaxActiveRemoteStreamId)
private Stream	createLocalStream(Request request)
private Stream	createRemoteStream(int streamId)
protected byte[]	Returns: The WINDOW_UPDATE frame if one is required or an empty array if no WINDOW_UPDATE is required. createWindowUpdateForSettings()
private int	decreaseStreamConcurrency()
protected void	decrementActiveRemoteStreamCount()
public void	destroy() Implements jakarta.servlet.http.HttpUpgradeHandler.destroy. This method is called after the upgraded connection has been closed.
protected Http2UpgradeHandler.HeaderFrameBuffers	doWriteHeaders(Stream stream, int pushedStreamId, MimeHeaders mimeHeaders, boolean endOfStream, int payloadSize)
public void	endRequestBodyFrame(int streamId, int dataLength) Implements org.apache.coyote.http2.Http2Parser.Output.endRequestBodyFrame.
pack-priv void	executeQueuedStream()
public boolean	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) Implements org.apache.coyote.http2.Http2Parser.Input.fill. Fill the given array with data unless non-blocking is requested and no data is available.
private AbstractNonZeroStream	getAbstractNonZeroStream(int streamId)
private AbstractNonZeroStream	getAbstractNonZeroStream(int streamId, boolean unknownIsError)
protected final String	getConnectionId() Implements abstract org.apache.coyote.http2.AbstractStream.getConnectionId.
protected Http2UpgradeHandler.HeaderFrameBuffers	getHeaderFrameBuffers(int initialPayloadSize)
public HpackDecoder	getHpackDecoder() Implements org.apache.coyote.http2.Http2Parser.Output.getHpackDecoder.
protected HpackEncoder	getHpackEncoder()
pack-priv ConnectionSettingsLocal	getLocalSettings()
public int	getMaxFrameSize() Implements org.apache.coyote.http2.Http2Parser.Input.getMaxFrameSize.
protected Http2Parser	getParser(String connectionId)
protected Http2UpgradeHandler.PingManager	getPingManager()
pack-priv Http2Protocol	getProtocol()
pack-priv ConnectionSettingsRemote	getRemoteSettings()
public ServletConnection	getServletConnection()
private Stream	getStream(int streamId)
private Stream	getStream(int streamId, boolean unknownIsError)
private int	getStreamConcurrency()
public void	goaway(int lastStreamId, long errorCode, String debugData) Implements org.apache.coyote.http2.Http2Parser.Output.goaway.
protected void	handleAppInitiatedIOException(IOException ioe)
public void	headersContinue(int payloadSize, boolean endOfHeaders) Implements org.apache.coyote.http2.Http2Parser.Output.headersContinue.
public void	headersEnd(int streamId, boolean endOfStream) Implements org.apache.coyote.http2.Http2Parser.Output.headersEnd.
public HpackDecoder.HeaderEmitter	headersStart(int streamId, boolean headersEndStream) Implements org.apache.coyote.http2.Http2Parser.Output.headersStart.
public void	increaseOverheadCount(FrameType frameType) Implements org.apache.coyote.http2.Http2Parser.Output.increaseOverheadCount.
private void	increaseOverheadCount(FrameType frameType, int increment)
private int	increaseStreamConcurrency()
protected void	incrementWindowSize(int The amount by which the window size should be increased increment) Overrides org.apache.coyote.http2.AbstractStream.incrementWindowSize. Increment window size.
public void	incrementWindowSize(int streamId, int increment) Implements org.apache.coyote.http2.Http2Parser.Output.incrementWindowSize.
public void	init(WebConnection The connection that has been upgraded webConnection) Implements jakarta.servlet.http.HttpUpgradeHandler.init. This method is called once the request/response pair where `HttpServletRequest#upgrade(Class)` is called has completed processing and is the point where control of the connection passes from the container to the `HttpUpgradeHandler`.
pack-priv boolean	isOverheadLimitExceeded()
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) Implements org.apache.coyote.http2.Http2Parser.Output.onSwallowedDataFramePayload. 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) Implements org.apache.coyote.http2.Http2Parser.Output.onSwallowedUnknownFrame. Notification triggered when the parser swallows the payload of an unknown frame.
public void	pause() Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.pause.
public void	pingReceive(byte[] payload, boolean ack) Implements org.apache.coyote.http2.Http2Parser.Output.pingReceive.
public void	priorityUpdate(int prioritizedStreamID, Priority p) Implements org.apache.coyote.http2.Http2Parser.Output.priorityUpdate.
protected void	processConnection(WebConnection webConnection, Stream stream)
protected SendfileState	Returns: The result of the send file processing processSendfile(SendfileData The stream and associated data to process sendfileData) Process send file (if supported) for the given stream.
protected void	processStreamOnContainerThread(Stream stream)
pack-priv void	processStreamOnContainerThread(StreamProcessor streamProcessor, SocketEvent event)
protected void	processWrites()
private void	pruneClosedStreams(int streamId)
pack-priv void	push(Request request, Stream associatedStream)
public void	receivedEndOfStream(int streamId) Implements org.apache.coyote.http2.Http2Parser.Output.receivedEndOfStream.
private void	receivedEndOfStream(Stream stream)
pack-priv void	reduceOverheadCount(FrameType frameType)
private Set<AbstractStream>	releaseBackLog(int increment)
pack-priv void	replaceStream(AbstractNonZeroStream original, AbstractNonZeroStream replacement)
public void	reprioritise(int Unused streamId, int Unused parentStreamId, boolean Unused exclusive, int Unused weight) Deprecated Unused. Will be removed in Tomcat 11 onwards. Unused - NO-OP.
pack-priv int	reserveWindowSize(Stream stream, int reservation, boolean block)
public void	reset(int streamId, long errorCode) Implements org.apache.coyote.http2.Http2Parser.Output.reset.
pack-priv void	sendStreamReset(StreamStateMachine state, StreamException se)
protected void	sentEndOfStream(Stream stream)
private void	setConnectionTimeout(long connectionTimeout)
protected void	setConnectionTimeoutForStreamCount(int streamCount)
private void	setMaxProcessedStream(int streamId)
public void	setSocketWrapper(SocketWrapperBase<?> wrapper) Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSocketWrapper.
public void	setSslSupport(SSLSupport sslSupport) Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.setSslSupport.
public void	setting(Setting setting, long value) Implements org.apache.coyote.http2.Http2Parser.Output.setting.
public void	settingsEnd(boolean ack) Implements org.apache.coyote.http2.Http2Parser.Output.settingsEnd.
public ByteBuffer	startRequestBodyFrame(int streamId, int payloadSize, boolean endOfStream) Implements org.apache.coyote.http2.Http2Parser.Output.startRequestBodyFrame.
public void	timeoutAsync(long now) Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.timeoutAsync.
private void	updateOverheadCount(FrameType frameType, int increment)
public AbstractEndpoint.Handler.SocketState	upgradeDispatch(SocketEvent status) Implements org.apache.coyote.http11.upgrade.InternalHttpUpgradeHandler.upgradeDispatch.
pack-priv void	writeBody(Stream stream, ByteBuffer data, int len, boolean finished)
protected void	writeGoAwayFrame(int maxStreamId, long errorCode, byte[] debugMsg)
pack-priv void	writeHeaders(Stream stream, int pushedStreamId, MimeHeaders mimeHeaders, boolean endOfStream, int payloadSize)
protected void	writeSettings() Write the initial settings frame and any necessary supporting frames.
pack-priv void	writeWindowUpdate(AbstractNonZeroStream stream, int increment, boolean applicationInitiated)

Inherited from org.apache.coyote.http2.AbstractStream:: decrementWindowSize getConnectionAllocationMade getConnectionAllocationRequested getIdAsInt getIdAsString getIdentifier getWindowSize setConnectionAllocationMade setConnectionAllocationRequested setWindowSize

pack-priv Class Http2UpgradeHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary