package flowcontrol

Import Path
	github.com/quic-go/quic-go/internal/flowcontrol (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    base_flow_controller.go
	    connection_flow_controller.go
	    interface.go
	    stream_flow_controller.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ConnectionFlowController (interface)
		The ConnectionFlowController is the flow controller for the connection.

		Methods (total 7)
			( ConnectionFlowController) AddBytesRead(protocol.ByteCount) (hasWindowUpdate bool)
			( ConnectionFlowController) AddBytesSent(protocol.ByteCount)
			( ConnectionFlowController) GetWindowUpdate(monotime.Time) protocol.ByteCount
				for receiving
				// returns 0 if no update is necessary

			( ConnectionFlowController) IsNewlyBlocked() (bool, protocol.ByteCount)
			( ConnectionFlowController) Reset() error
			( ConnectionFlowController) SendWindowSize() protocol.ByteCount
				for sending

			( ConnectionFlowController) UpdateSendWindow(protocol.ByteCount) (updated bool)
		As Inputs Of (at least one exported)
			func NewStreamFlowController(streamID protocol.StreamID, cfc ConnectionFlowController, receiveWindow protocol.ByteCount, maxReceiveWindow protocol.ByteCount, initialSendWindow protocol.ByteCount, rttStats *utils.RTTStats, logger utils.Logger) StreamFlowController

	 type StreamFlowController (interface)
		A StreamFlowController is a flow controller for a QUIC stream.

		Methods (total 8)
			( StreamFlowController) Abandon()
				Abandon is called when reading from the stream is aborted early,
				and there won't be any further calls to AddBytesRead.

			( StreamFlowController) AddBytesRead(protocol.ByteCount) (hasStreamWindowUpdate, hasConnWindowUpdate bool)
			( StreamFlowController) AddBytesSent(protocol.ByteCount)
			( StreamFlowController) GetWindowUpdate(monotime.Time) protocol.ByteCount
				for receiving
				// returns 0 if no update is necessary

			( StreamFlowController) IsNewlyBlocked() bool
			( StreamFlowController) SendWindowSize() protocol.ByteCount
				for sending

			( StreamFlowController) UpdateHighestReceived(offset protocol.ByteCount, final bool, now monotime.Time) error
				UpdateHighestReceived is called when a new highest offset is received
				final has to be to true if this is the final offset of the stream,
				as contained in a STREAM frame with FIN bit, and the RESET_STREAM frame

			( StreamFlowController) UpdateSendWindow(protocol.ByteCount) (updated bool)
		As Outputs Of (at least one exported)
			func NewStreamFlowController(streamID protocol.StreamID, cfc ConnectionFlowController, receiveWindow protocol.ByteCount, maxReceiveWindow protocol.ByteCount, initialSendWindow protocol.ByteCount, rttStats *utils.RTTStats, logger utils.Logger) StreamFlowController


Package-Level Functions (total 2)

	 func NewConnectionFlowController(receiveWindow protocol.ByteCount, maxReceiveWindow protocol.ByteCount, allowWindowIncrease func(size protocol.ByteCount) bool, rttStats *utils.RTTStats, logger utils.Logger) *connectionFlowController
		NewConnectionFlowController gets a new flow controller for the connection
		It is created before we receive the peer's transport parameters, thus it starts with a sendWindow of 0.

	 func NewStreamFlowController(streamID protocol.StreamID, cfc ConnectionFlowController, receiveWindow protocol.ByteCount, maxReceiveWindow protocol.ByteCount, initialSendWindow protocol.ByteCount, rttStats *utils.RTTStats, logger utils.Logger) StreamFlowController
		NewStreamFlowController gets a new flow controller for a stream

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.