package ackhandler

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

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	    ack_eliciting.go
	    ecn.go
	    frame.go
	    interfaces.go
	    lost_packet_tracker.go
	    packet.go
	    packet_number_generator.go
	    received_packet_handler.go
	    received_packet_history.go
	    received_packet_tracker.go
	    send_mode.go
	    sent_packet_handler.go
	    sent_packet_history.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type Frame (struct)

		Fields (total 2)
			Frame wire.Frame
				// nil if the frame has already been acknowledged in another packet

			Handler FrameHandler
		As Inputs Of (at least 2)
			func HasAckElicitingFrames(fs []Frame) bool
			func SentPacketHandler.SentPacket(t monotime.Time, pn, largestAcked protocol.PacketNumber, streamFrames []StreamFrame, frames []Frame, encLevel protocol.EncryptionLevel, ecn protocol.ECN, size protocol.ByteCount, isPathMTUProbePacket, isPathProbePacket bool)

	 type FrameHandler (interface)
		FrameHandler handles the acknowledgement and the loss of a frame.

		Methods (total 2)
			( FrameHandler) OnAcked(wire.Frame)
			( FrameHandler) OnLost(wire.Frame)

	 type ReceivedPacketHandler (struct)

		Methods (total 6)
			(*ReceivedPacketHandler) DropPackets(encLevel protocol.EncryptionLevel)
			(*ReceivedPacketHandler) GetAckFrame(encLevel protocol.EncryptionLevel, now monotime.Time, onlyIfQueued bool) *wire.AckFrame
			(*ReceivedPacketHandler) GetAlarmTimeout() monotime.Time
			(*ReceivedPacketHandler) IgnorePacketsBelow(pn protocol.PacketNumber)
			(*ReceivedPacketHandler) IsPotentiallyDuplicate(pn protocol.PacketNumber, encLevel protocol.EncryptionLevel) bool
			(*ReceivedPacketHandler) ReceivedPacket(pn protocol.PacketNumber, ecn protocol.ECN, encLevel protocol.EncryptionLevel, rcvTime monotime.Time, ackEliciting bool) error
		As Outputs Of (at least one exported)
			func NewReceivedPacketHandler(logger utils.Logger) *ReceivedPacketHandler

	 type SendMode uint8 (basic type)
		The SendMode says what kind of packets can be sent.

		Methods (only one)
			( SendMode) String() string
		Implements (at least 2)
			 SendMode : expvar.Var
			 SendMode : fmt.Stringer
		As Outputs Of (at least one exported)
			func SentPacketHandler.SendMode(now monotime.Time) SendMode
		As Types Of (total 7)
			const SendAck
			const SendAny
			const SendNone
			const SendPacingLimited
			const SendPTOAppData
			const SendPTOHandshake
			const SendPTOInitial

	 type SentPacketHandler (interface)
		SentPacketHandler handles ACKs received for outgoing packets

		Methods (total 16)
			( SentPacketHandler) DropPackets(_ protocol.EncryptionLevel, rcvTime monotime.Time)
			( SentPacketHandler) ECNMode(isShortHeaderPacket bool) protocol.ECN
				// isShortHeaderPacket should only be true for non-coalesced 1-RTT packets

			( SentPacketHandler) GetLossDetectionTimeout() monotime.Time
			( SentPacketHandler) MigratedPath(now monotime.Time, initialMaxPacketSize protocol.ByteCount)
			( SentPacketHandler) OnLossDetectionTimeout(now monotime.Time) error
			( SentPacketHandler) PeekPacketNumber(protocol.EncryptionLevel) (protocol.PacketNumber, protocol.PacketNumberLen)
			( SentPacketHandler) PopPacketNumber(protocol.EncryptionLevel) protocol.PacketNumber
			( SentPacketHandler) QueueProbePacket(protocol.EncryptionLevel) bool
				only to be called once the handshake is complete
				// was a packet queued

			( SentPacketHandler) ReceivedAck(f *wire.AckFrame, encLevel protocol.EncryptionLevel, rcvTime monotime.Time) (bool, error)
				ReceivedAck processes an ACK frame.
				It does not store a copy of the frame.

			( SentPacketHandler) ReceivedBytes(_ protocol.ByteCount, rcvTime monotime.Time)
			( SentPacketHandler) ReceivedPacket(protocol.EncryptionLevel, monotime.Time)
			( SentPacketHandler) ResetForRetry(rcvTime monotime.Time)
			( SentPacketHandler) SendMode(now monotime.Time) SendMode
				The SendMode determines if and what kind of packets can be sent.

			( SentPacketHandler) SentPacket(t monotime.Time, pn, largestAcked protocol.PacketNumber, streamFrames []StreamFrame, frames []Frame, encLevel protocol.EncryptionLevel, ecn protocol.ECN, size protocol.ByteCount, isPathMTUProbePacket, isPathProbePacket bool)
				SentPacket may modify the packet

			( SentPacketHandler) SetMaxDatagramSize(count protocol.ByteCount)
			( SentPacketHandler) TimeUntilSend() monotime.Time
				TimeUntilSend is the time when the next packet should be sent.
				It is used for pacing packets.

		As Outputs Of (at least one exported)
			func NewSentPacketHandler(initialPN protocol.PacketNumber, initialMaxDatagramSize protocol.ByteCount, rttStats *utils.RTTStats, connStats *utils.ConnectionStats, clientAddressValidated bool, enableECN bool, ignorePacketsBelow func(protocol.PacketNumber), pers protocol.Perspective, qlogger qlogwriter.Recorder, logger utils.Logger) SentPacketHandler

	 type StreamFrame (struct)

		Fields (total 2)
			Frame *wire.StreamFrame
			Handler FrameHandler
		As Inputs Of (at least one exported)
			func SentPacketHandler.SentPacket(t monotime.Time, pn, largestAcked protocol.PacketNumber, streamFrames []StreamFrame, frames []Frame, encLevel protocol.EncryptionLevel, ecn protocol.ECN, size protocol.ByteCount, isPathMTUProbePacket, isPathProbePacket bool)


Package-Level Functions (total 5)

	 func HasAckElicitingFrames(fs []Frame) bool
		HasAckElicitingFrames returns true if at least one frame is ack-eliciting.

	 func IsFrameAckEliciting(f wire.Frame) bool
		IsFrameAckEliciting returns true if the frame is ack-eliciting.

	 func IsFrameTypeAckEliciting(t wire.FrameType) bool
		IsFrameTypeAckEliciting returns true if the frame is ack-eliciting.

	 func NewReceivedPacketHandler(logger utils.Logger) *ReceivedPacketHandler
	 func NewSentPacketHandler(initialPN protocol.PacketNumber, initialMaxDatagramSize protocol.ByteCount, rttStats *utils.RTTStats, connStats *utils.ConnectionStats, clientAddressValidated bool, enableECN bool, ignorePacketsBelow func(protocol.PacketNumber), pers protocol.Perspective, qlogger qlogwriter.Recorder, logger utils.Logger) SentPacketHandler
		clientAddressValidated indicates whether the address was validated beforehand by an address validation token.
		If the address was validated, the amplification limit doesn't apply. It has no effect for a client.


Package-Level Constants (total 7)

	const SendAck SendMode = 1
		SendAck means an ACK-only packet should be sent

	const SendAny SendMode = 6
		SendAny means that any packet should be sent

	const SendNone SendMode = 0
		SendNone means that no packets should be sent

	const SendPacingLimited SendMode = 5
		SendPacingLimited means that the pacer doesn't allow sending of a packet right now,
		but will do in a little while.
		The timestamp when sending is allowed again can be obtained via the SentPacketHandler.TimeUntilSend.

	const SendPTOAppData SendMode = 4
		SendPTOAppData means that an Application data probe packet should be sent

	const SendPTOHandshake SendMode = 3
		SendPTOHandshake means that a Handshake probe packet should be sent

	const SendPTOInitial SendMode = 2
		SendPTOInitial means that an Initial probe packet should be sent

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.