org.apache.pekko.http.impl.engine.http2

Interface Http2StreamHandling

All Superinterfaces:

org.apache.pekko.macros.LogHelper, org.apache.pekko.macros.LogHelperMacro

public interface Http2StreamHandling
extends org.apache.pekko.macros.LogHelper

INTERNAL API

Handles HTTP/2 stream states Accepts FrameEvents from the network side and emits ByteHttp2SubStreams for streams to be handled by the Pekko HTTP layer.

Mixed into the Http2ServerDemux graph logic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Http2StreamHandling.Closed$
static class	Http2StreamHandling.CollectingIncomingData Special state that allows collecting some incoming data before dispatching it either as strict or streamed entity
static class	Http2StreamHandling.CollectingIncomingData$
static class	Http2StreamHandling.HalfClosedLocal We have closed the outgoing stream, but the incoming stream is still going.
static class	Http2StreamHandling.HalfClosedLocal$
static class	Http2StreamHandling.HalfClosedLocalWaitingForPeerStream
static class	Http2StreamHandling.HalfClosedLocalWaitingForPeerStream$
static class	Http2StreamHandling.HalfClosedRemoteSendingData They have closed the incoming stream, but the outgoing stream is still going.
static class	Http2StreamHandling.HalfClosedRemoteSendingData$
static class	Http2StreamHandling.HalfClosedRemoteWaitingForOutgoingStream
static class	Http2StreamHandling.HalfClosedRemoteWaitingForOutgoingStream$
static class	Http2StreamHandling.Idle$
static class	Http2StreamHandling.IncomingStreamBuffer
static class	Http2StreamHandling.Open
static class	Http2StreamHandling.Open$
static class	Http2StreamHandling.OpenReceivingDataFirst
static class	Http2StreamHandling.OpenReceivingDataFirst$
static class	Http2StreamHandling.OpenSendingData
static class	Http2StreamHandling.OpenSendingData$
static interface	Http2StreamHandling.OutStream
static class	Http2StreamHandling.OutStream$
static class	Http2StreamHandling.OutStreamImpl
static class	Http2StreamHandling.ReceivingData
static class	Http2StreamHandling.ReceivingDataWithBuffer
static interface	Http2StreamHandling.Sending
static class	Http2StreamHandling.StreamState States roughly correspond to states as given in https://http2.github.io/http2-spec/#StreamStates.

Method Summary

Modifier and Type	Method and Description
int	activeStreamCount()
Http2StreamHandling.Closed$	Closed() Accessor for nested Scala object
void	dispatchSubstream(FrameEvent.ParsedHeadersFrame initialHeaders, scala.util.Either<org.apache.pekko.util.ByteString,org.apache.pekko.stream.scaladsl.Source<java.lang.Object,java.lang.Object>> data, scala.collection.immutable.Map<AttributeKey<?>,java.lang.Object> correlationAttributes)
void	distributeWindowDeltaToAllStreams(int delta) Called by multiplexer to distribute changes from INITIAL_WINDOW_SIZE to all streams
void	enqueueOutStream(int streamId)
IncomingFlowController	flowController()
void	handleOutgoingCreated(Http2SubStream stream) Called by Http2ServerDemux when a stream comes in from the user-handler
void	handleOutgoingEnded(int streamId)
void	handleOutgoingFailed(int streamId, java.lang.Throwable cause)
void	handleStreamEvent(FrameEvent.StreamFrameEvent e) Called by Http2ServerDemux to let the state machine handle StreamFrameEvents
boolean	hasCapacityToCreateStreams()
Http2StreamHandling.Idle$	Idle() Accessor for nested Scala object
void	incomingStreamPulled(int streamId) Entry-point to handle IncomingStreamBuffer.onPull through the state machine
boolean	isServer()
boolean	isUpgraded()
int	lastStreamId() The "last peer-initiated stream that was or might be processed on the sending endpoint in this connection"
Http2Multiplexer	multiplexer()
void	onAllStreamsClosed() Called when all streams in StreamHandling buffers are closed and the stage is completing.
Http2StreamHandling.OutStream$	OutStream() Accessor for nested Scala object
PullFrameResult	pullNextFrame(int streamId, int maxSize) Called by the multiplexer if ready to send a data frame
void	pushGOAWAY(Http2Protocol.ErrorCode errorCode, java.lang.String debug)
void	resetStream(int streamId, Http2Protocol.ErrorCode errorCode)
void	setMaxConcurrentStreams(int newValue)
Http2CommonSettings	settings()
void	shutdownStreamHandling() Called to cleanup any state when the connection is torn down
Http2StreamHandling.StreamState	streamFor(int streamId)
void	tryPullSubStreams() Tries to generate demand of SubStreams on the inlet from the user handler.
void	updateAllStates(scala.Function1<Http2StreamHandling.StreamState,Http2StreamHandling.StreamState> handle, java.lang.String event, java.lang.Object eventArg)
void	updateState(int streamId, scala.Function1<Http2StreamHandling.StreamState,Http2StreamHandling.StreamState> handle, java.lang.String event, java.lang.Object eventArg)
<R> R	updateStateAndReturn(int streamId, scala.Function1<Http2StreamHandling.StreamState,scala.Tuple2<Http2StreamHandling.StreamState,R>> handle, java.lang.String event, java.lang.Object eventArg)
scala.Option<HttpEntity.ChunkStreamPart>	wrapTrailingHeaders(FrameEvent.ParsedHeadersFrame headers)

Methods inherited from interface org.apache.pekko.macros.LogHelper

$init$, isDebugEnabled, isInfoEnabled, isWarningEnabled, log, prefixString

Methods inherited from interface org.apache.pekko.macros.LogHelperMacro

$init$, debugMacro, infoMacro, warningMacro

Method Detail

Idle

Http2StreamHandling.Idle$ Idle()

Accessor for nested Scala object

Returns:

(undocumented)

Closed

Http2StreamHandling.Closed$ Closed()

Accessor for nested Scala object

Returns:

(undocumented)

OutStream

Http2StreamHandling.OutStream$ OutStream()

Accessor for nested Scala object

Returns:

(undocumented)

isServer

boolean isServer()

multiplexer

Http2Multiplexer multiplexer()

settings

Http2CommonSettings settings()

pushGOAWAY

void pushGOAWAY(Http2Protocol.ErrorCode errorCode,
                java.lang.String debug)

dispatchSubstream

void dispatchSubstream(FrameEvent.ParsedHeadersFrame initialHeaders,
                       scala.util.Either<org.apache.pekko.util.ByteString,org.apache.pekko.stream.scaladsl.Source<java.lang.Object,java.lang.Object>> data,
                       scala.collection.immutable.Map<AttributeKey<?>,java.lang.Object> correlationAttributes)

isUpgraded

boolean isUpgraded()

wrapTrailingHeaders

scala.Option<HttpEntity.ChunkStreamPart> wrapTrailingHeaders(FrameEvent.ParsedHeadersFrame headers)

flowController

IncomingFlowController flowController()

tryPullSubStreams

void tryPullSubStreams()

Tries to generate demand of SubStreams on the inlet from the user handler. The attemp to demand will succeed if the inlet is open and has no pending pull, and, in the case of a client, if we're not exceedingthe number of active streams. This method must be invoked any time the collection of active streams or the value of maxConcurrentStreams are modified but the invocation must happen _after_ the collection or the limit are modified.

lastStreamId

int lastStreamId()

The "last peer-initiated stream that was or might be processed on the sending endpoint in this connection"

Returns:

(undocumented)

See Also:

http://httpwg.org/specs/rfc7540.html#rfc.section.6.8

setMaxConcurrentStreams

void setMaxConcurrentStreams(int newValue)

hasCapacityToCreateStreams

boolean hasCapacityToCreateStreams()

Returns:

true if the number of outgoing Active streams (Active includes Open and any variant of HalfClosedXxx) doesn't exceed MaxConcurrentStreams

onAllStreamsClosed

void onAllStreamsClosed()

Called when all streams in StreamHandling buffers are closed and the stage is completing.

streamFor

Http2StreamHandling.StreamState streamFor(int streamId)

activeStreamCount

int activeStreamCount()

handleStreamEvent

void handleStreamEvent(FrameEvent.StreamFrameEvent e)

Called by Http2ServerDemux to let the state machine handle StreamFrameEvents

handleOutgoingCreated

void handleOutgoingCreated(Http2SubStream stream)

Called by Http2ServerDemux when a stream comes in from the user-handler

handleOutgoingEnded

void handleOutgoingEnded(int streamId)

handleOutgoingFailed

void handleOutgoingFailed(int streamId,
                          java.lang.Throwable cause)

distributeWindowDeltaToAllStreams

void distributeWindowDeltaToAllStreams(int delta)

Called by multiplexer to distribute changes from INITIAL_WINDOW_SIZE to all streams

pullNextFrame

PullFrameResult pullNextFrame(int streamId,
                              int maxSize)

Called by the multiplexer if ready to send a data frame

incomingStreamPulled

void incomingStreamPulled(int streamId)

Entry-point to handle IncomingStreamBuffer.onPull through the state machine

updateAllStates

void updateAllStates(scala.Function1<Http2StreamHandling.StreamState,Http2StreamHandling.StreamState> handle,
                     java.lang.String event,
                     java.lang.Object eventArg)

updateState

void updateState(int streamId,
                 scala.Function1<Http2StreamHandling.StreamState,Http2StreamHandling.StreamState> handle,
                 java.lang.String event,
                 java.lang.Object eventArg)

enqueueOutStream

void enqueueOutStream(int streamId)

updateStateAndReturn

<R> R updateStateAndReturn(int streamId,
                           scala.Function1<Http2StreamHandling.StreamState,scala.Tuple2<Http2StreamHandling.StreamState,R>> handle,
                           java.lang.String event,
                           java.lang.Object eventArg)

shutdownStreamHandling

void shutdownStreamHandling()

Called to cleanup any state when the connection is torn down

resetStream

void resetStream(int streamId,
                 Http2Protocol.ErrorCode errorCode)