blaze-http
0.23.14
API
Generated with
blaze-http/org.http4s.blaze.http.http2/SessionFlowControl

SessionFlowControl

org.http4s.blaze.http.http2.SessionFlowControl
abstract class SessionFlowControl

Flow control representation of a Http2 Session

Attributes

Source:
SessionFlowControl.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def newStreamFlowWindow(streamId: Int): StreamFlowWindow

Create a new StreamFlowWindow for a stream which will update and check the bounds of the session flow control state.

Create a new StreamFlowWindow for a stream which will update and check the bounds of the session flow control state.

Attributes

Note:

the stream StreamFlowWindow is not thread safe.

Source:
SessionFlowControl.scala
def sessionInboundAcked(count: Int): Unit

Update the session inbound window

Update the session inbound window

Attributes

Source:
SessionFlowControl.scala
def sessionInboundConsumed(count: Int): Unit

Signal that inbound bytes have been consumed that are not tracked by a stream

Signal that inbound bytes have been consumed that are not tracked by a stream

Attributes

Source:
SessionFlowControl.scala
def sessionInboundObserved(count: Int): Boolean

Observe inbound bytes that don't belong to an active inbound stream

Observe inbound bytes that don't belong to an active inbound stream

Attributes

count

bytes observed

Returns:

true if there was sufficient session flow window remaining, false otherwise.

Source:
SessionFlowControl.scala
def sessionInboundWindow: Int

Get the number of bytes remaining in the inbound flow window

Get the number of bytes remaining in the inbound flow window

Attributes

Source:
SessionFlowControl.scala
def sessionOutboundAcked(count: Int): Option[Http2Exception]

Update the session outbound window

Update the session outbound window

Attributes

Note:

there is no way to withdraw outbound bytes directly from the session as there should always be an associated stream when sending flow control counted bytes outbound.

Source:
SessionFlowControl.scala
def sessionOutboundWindow: Int

Get the remaining bytes in the sessions outbound flow window

Get the remaining bytes in the sessions outbound flow window

Attributes

Source:
SessionFlowControl.scala
def sessionUnconsumedBytes: Int

Get the total number of inbound bytes that have yet to be consumed by the streams

Get the total number of inbound bytes that have yet to be consumed by the streams

Attributes

Source:
SessionFlowControl.scala
Generated with