spec

Documentation

Overview

Package spec contains constants and structs. See also the spec: https://github.com/m-lab/ndt-server/blob/master/spec/ndt7-protocol.md

Index

• Constants
• type AppInfo
• type BBRInfo
• type ConnectionInfo
• type Measurement
• type OriginKind
• type TCPInfo
• type TestKind

Constants

const (
	// OriginClient indicates that the measurement origin is the client.
	OriginClient = OriginKind("client")

	// OriginServer indicates that the measurement origin is the server.
	OriginServer = OriginKind("server")

	// TestDownload indicates that this is a download.
	TestDownload = TestKind("download")

	// TestUpload indicates that this is an upload.
	TestUpload = TestKind("upload")
)

Types

type AppInfo

type AppInfo model.AppInfo

AppInfo contains an application level measurement.

type BBRInfo

type BBRInfo model.BBRInfo

BBRInfo contains a BBR measurement.

type ConnectionInfo

type ConnectionInfo model.ConnectionInfo

ConnectionInfo contains info on this connection.

type Measurement

type Measurement struct {
	// AppInfo contains application level measurements.
	AppInfo *AppInfo `json:",omitempty"`

	// BBRInfo is the data measured using TCP BBR instrumentation.
	BBRInfo *BBRInfo `json:",omitempty"`

	// ConnectionInfo contains info on the connection.
	ConnectionInfo *ConnectionInfo `json:",omitempty"`

	// Origin indicates who performed this measurement.
	Origin OriginKind `json:",omitempty"`

	// Test contains the test name.
	Test TestKind `json:",omitempty"`

	// TCPInfo contains metrics measured using TCP_INFO instrumentation.
	TCPInfo *TCPInfo `json:",omitempty"`
}

The Measurement struct contains measurement results. This message is an extension of the one inside of v0.7.0 of the ndt7 spec.

type OriginKind

type OriginKind string

OriginKind indicates the origin of a measurement.

type TCPInfo

type TCPInfo model.TCPInfo

TCPInfo contains a TCP_INFO measurement.

type TestKind

type TestKind string

TestKind indicates the direction of a measurement.