Top Description Inners Fields Constructors Methods

org.apache.coyote.http2

pack-priv Class StreamStateMachine

Class Inheritance

extends Object

java.lang.Object
org.apache.coyote.http2.StreamStateMachine

Imports

java.util.Arrays, .HashSet, .Set, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.res.StringManager

See state diagram in RFC 7540.
The following additions are supported by this state machine:

differentiate between closed (normal) and closed caused by reset

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	StreamStateMachine.State

Field Summary

Modifier and Type	Field and Description
private final String	connectionId
private static final Log	log
private static final StringManager	sm
private StreamStateMachine.State	state
private final String	streamId

Constructor Summary

Access	Constructor and Description
pack-priv	StreamStateMachine(String connectionId, String streamId)

Method Summary

Modifier and Type	Method and Description
pack-priv final synchronized boolean	canRead()
pack-priv final synchronized boolean	canWrite()
pack-priv final synchronized void	checkFrameType(FrameType frameType)
pack-priv final synchronized void	closeIfIdle()
pack-priv final synchronized String	getCurrentStateName()
pack-priv final synchronized boolean	isActive()
pack-priv final synchronized boolean	isClosedFinal()
pack-priv final synchronized boolean	isFrameTypePermitted(FrameType frameType)
pack-priv final synchronized void	receivedEndOfStream()
pack-priv final synchronized void	receivedReset()
pack-priv final synchronized void	receivedStartOfHeaders()
public synchronized void	sendReset() Marks the stream as reset.
pack-priv final synchronized void	sentEndOfStream()
pack-priv final synchronized void	sentHeaders()
pack-priv final synchronized void	sentPushPromise()
private void	stateChange(StreamStateMachine.State oldState, StreamStateMachine.State newState)

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

Field Detail

connectionId	back to summary
private final String connectionId

log	back to summary
private static final Log log

sm	back to summary
private static final StringManager sm

state	back to summary
private StreamStateMachine.State state

streamId	back to summary
private final String streamId

Constructor Detail

StreamStateMachine	back to summary
pack-priv StreamStateMachine(String connectionId, String streamId)

Method Detail

canRead	back to summary
pack-priv final synchronized boolean canRead()

canWrite	back to summary
pack-priv final synchronized boolean canWrite()

checkFrameType	back to summary
pack-priv final synchronized void checkFrameType(FrameType frameType) throws Http2Exception

closeIfIdle	back to summary
pack-priv final synchronized void closeIfIdle()

getCurrentStateName	back to summary
pack-priv final synchronized String getCurrentStateName()

isActive	back to summary
pack-priv final synchronized boolean isActive()

isClosedFinal	back to summary
pack-priv final synchronized boolean isClosedFinal()

isFrameTypePermitted	back to summary
pack-priv final synchronized boolean isFrameTypePermitted(FrameType frameType)

receivedEndOfStream	back to summary
pack-priv final synchronized void receivedEndOfStream()

receivedReset	back to summary
pack-priv final synchronized void receivedReset()

receivedStartOfHeaders	back to summary
pack-priv final synchronized void receivedStartOfHeaders()

sendReset

back to summary

public synchronized void sendReset()

Marks the stream as reset. This method will not change the stream state if:

The stream is already reset
The stream is already closed

Exceptions

IllegalStateException:: If the stream is in a state that does not permit resets

sentEndOfStream	back to summary
pack-priv final synchronized void sentEndOfStream()

sentHeaders	back to summary
pack-priv final synchronized void sentHeaders()

sentPushPromise	back to summary
pack-priv final synchronized void sentPushPromise()

stateChange	back to summary
private void stateChange(StreamStateMachine.State oldState, StreamStateMachine.State newState)

org.apache.coyote.http2 back to summary

private final Enum StreamStateMachine.State

Class Inheritance

extends Enum<StreamStateMachine.State>

java.lang.Object
java.lang.Enum
org.apache.coyote.http2.StreamStateMachine.State

Field Summary

Modifier and Type	Field and Description
private final boolean	canRead
private final boolean	canReset
private final boolean	canWrite
public static final StreamStateMachine.State	CLOSED_FINAL
public static final StreamStateMachine.State	CLOSED_RST_RX
public static final StreamStateMachine.State	CLOSED_RST_TX
public static final StreamStateMachine.State	CLOSED_RX
public static final StreamStateMachine.State	CLOSED_TX
private final boolean	connectionErrorForInvalidFrame
private final Http2Error	errorCodeForInvalidFrame
private final Set<FrameType>	frameTypesPermitted
public static final StreamStateMachine.State	HALF_CLOSED_LOCAL
public static final StreamStateMachine.State	HALF_CLOSED_REMOTE
public static final StreamStateMachine.State	IDLE
public static final StreamStateMachine.State	OPEN
public static final StreamStateMachine.State	RESERVED_LOCAL
public static final StreamStateMachine.State	RESERVED_REMOTE

Constructor Summary

Access	Constructor and Description
private	State(boolean canRead, boolean canWrite, boolean canReset, boolean connectionErrorForInvalidFrame, Http2Error errorCode, FrameType... frameTypes)

Method Summary

Modifier and Type	Method and Description
public boolean	canRead()
public boolean	canReset()
public boolean	canWrite()
public boolean	isActive()
public boolean	isFrameTypePermitted(FrameType frameType)
public static StreamStateMachine.State	valueOf(String name)
public static StreamStateMachine.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

canRead	back to summary
private final boolean canRead

canReset	back to summary
private final boolean canReset

canWrite	back to summary
private final boolean canWrite

CLOSED_FINAL	back to summary
public static final StreamStateMachine.State CLOSED_FINAL

CLOSED_RST_RX	back to summary
public static final StreamStateMachine.State CLOSED_RST_RX

CLOSED_RST_TX	back to summary
public static final StreamStateMachine.State CLOSED_RST_TX

CLOSED_RX	back to summary
public static final StreamStateMachine.State CLOSED_RX

CLOSED_TX	back to summary
public static final StreamStateMachine.State CLOSED_TX

connectionErrorForInvalidFrame	back to summary
private final boolean connectionErrorForInvalidFrame

errorCodeForInvalidFrame	back to summary
private final Http2Error errorCodeForInvalidFrame

frameTypesPermitted	back to summary
private final Set<FrameType> frameTypesPermitted

HALF_CLOSED_LOCAL	back to summary
public static final StreamStateMachine.State HALF_CLOSED_LOCAL

HALF_CLOSED_REMOTE	back to summary
public static final StreamStateMachine.State HALF_CLOSED_REMOTE

IDLE	back to summary
public static final StreamStateMachine.State IDLE

OPEN	back to summary
public static final StreamStateMachine.State OPEN

RESERVED_LOCAL	back to summary
public static final StreamStateMachine.State RESERVED_LOCAL

RESERVED_REMOTE	back to summary
public static final StreamStateMachine.State RESERVED_REMOTE

Constructor Detail

State	back to summary
private State(boolean canRead, boolean canWrite, boolean canReset, boolean connectionErrorForInvalidFrame, Http2Error errorCode, FrameType... frameTypes)

Method Detail

canRead	back to summary
public boolean canRead()

canReset	back to summary
public boolean canReset()

canWrite	back to summary
public boolean canWrite()

isActive	back to summary
public boolean isActive()

isFrameTypePermitted	back to summary
public boolean isFrameTypePermitted(FrameType frameType)

valueOf	back to summary
public static StreamStateMachine.State valueOf(String name)

values	back to summary
public static StreamStateMachine.State[] values()