quictrace

README

quic-trace Adapter

This is an experimental implementation of the log format consumed by quic-trace.

At this moment, this package comes with no API stability whatsoever.

Documentation

Index

• type Event
• type EventType
• type Tracer
  • func NewTracer() Tracer
• type TransportState

Types

type Event

type Event struct {
	Time      time.Time
	EventType EventType

	TransportState  *TransportState
	EncryptionLevel protocol.EncryptionLevel
	PacketNumber    protocol.PacketNumber
	PacketSize      protocol.ByteCount
	Frames          []wire.Frame
}

Event is a quic-traceable event

type EventType

type EventType uint8

EventType is the type of an event

const (
	// PacketSent means that a packet was sent
	PacketSent EventType = 1 + iota
	// PacketReceived means that a packet was received
	PacketReceived
	// PacketLost means that a packet was lost
	PacketLost
)

type Tracer

type Tracer interface {
	Trace(protocol.ConnectionID, Event)
	GetAllTraces() map[string][]byte
}

A Tracer traces a QUIC connection

func NewTracer

func NewTracer() Tracer

NewTracer creates a new Tracer

type TransportState

type TransportState struct {
	MinRTT      time.Duration
	SmoothedRTT time.Duration
	LatestRTT   time.Duration

	BytesInFlight    protocol.ByteCount
	CongestionWindow protocol.ByteCount
	InSlowStart      bool
	InRecovery       bool
}

TransportState contains some transport and congestion statistics