client

type Config struct {
	// Server is the server to connect to. If empty, the server is obtained by
	// querying the configured Locator.
	Server string

	// Scheme is the WebSocket scheme used to connect to the server (ws or wss).
	Scheme string

	// NumStreams is the number of streams that will be spawned by this client to run a
	// download or an upload test.
	NumStreams int

	// Length is the duration of the test.
	Length time.Duration

	// Delay is the delay between each stream.
	Delay time.Duration

	// CongestionControl is the congestion control algorithm to request from the server.
	CongestionControl string

	// MeasurementID is the manually configured Measurement ID ("mid") to pass to the server.
	MeasurementID string

	// Emitter is the interface used to emit the results of the test. It can be overridden
	// to provide a custom output.
	Emitter Emitter

	// NoVerify disables the TLS certificate verification.
	NoVerify bool

	// ByteLimit is the maximum number of bytes to download or upload. If set to 0, the
	// limit is disabled.
	ByteLimit int
}

type Emitter interface {
	// OnStart is called when a stream starts.
	OnStart(server string, kind spec.SubtestKind)
	// OnConnect is called when the WebSocket connection is established.
	OnConnect(server string)
	// OnMeasurement is called on received Measurement objects.
	OnMeasurement(id int, m model.WireMeasurement)
	// OnResult is called when the aggregate result is ready.
	OnResult(Result)
	// OnError is called on errors.
	OnError(err error)
	// OnStreamComplete is called after a stream completes.
	OnStreamComplete(streamID int, server string)
	// OnDebug is called to print debug information.
	OnDebug(msg string)
	// OnSummary is called to print summary information.
	OnSummary(results map[spec.SubtestKind]Result)
}

type HumanReadable struct {
	Debug bool
}

type Locator interface {
	Nearest(ctx context.Context, service string) ([]v2.Target, error)
}

type Result struct {
	// Subtest is the subtest this Result refers to.
	Subtest spec.SubtestKind
	// Goodput is the average number of application-level bits per second that
	// have been transferred so far across all the streams.
	Goodput float64
	// Throughput is the average number of network-level bits per second that
	// have been transferred so far across all the streams.
	Throughput float64
	// Elapsed is the total time elapsed since the test started.
	Elapsed time.Duration
	// RTT is the latest RTT value from TCPInfo from any stream.
	RTT uint32
	// MinRTT is the minimum of RTT values observed across all the streams.
	MinRTT uint32
	// Streams is the number of streams used in the test.
	Streams int
	// ByteLimit is the byte limit used in the test.
	ByteLimit int
	// Length is the length of the test.
	Length time.Duration
	// CongestionControl is the congestion control used in the test.
	CongestionControl string
}

type Throughput1Client struct {
	// ClientName is the name of the client sent to the server as part of the user-agent.
	ClientName string
	// ClientVersion is the version of the client sent to the server as part of the user-agent.
	ClientVersion string
	// contains filtered or unexported fields
}