s2c

Documentation

Index

• type ArchivalData
  • func ManageTest(ctx context.Context, controlConn protocol.Connection, s ndt.Server) (record *ArchivalData, err error)

Types

type ArchivalData

type ArchivalData struct {
	// This is the only field that is really required.
	UUID string

	// The server and client IP are here as well as in the containing struct
	// because happy eyeballs means that we may have a IPv4 control connection
	// causing a IPv6 connection to the test port or vice versa.
	ServerIP   string
	ServerPort int
	ClientIP   string
	ClientPort int

	StartTime          time.Time
	EndTime            time.Time
	MeanThroughputMbps float64
	MinRTT             time.Duration
	MaxRTT             time.Duration
	SumRTT             time.Duration
	CountRTT           uint32
	ClientReportedMbps float64

	TCPInfo *tcp.LinuxTCPInfo `json:",omitempty"`
	Error   string            `json:",omitempty"`
}

ArchivalData is the data saved by the S2C test. If a researcher wants deeper data, then they should use the UUID to get deeper data from tcp-info.

func ManageTest

func ManageTest(ctx context.Context, controlConn protocol.Connection, s ndt.Server) (record *ArchivalData, err error)

ManageTest manages the s2c test lifecycle