model

Documentation

Overview

Package model contains the ndt7 data model

Index

• type AppInfo
• type ArchivalData
• type BBRInfo
• type ConnectionInfo
• type Measurement
• type TCPInfo

Types

type AppInfo

type AppInfo struct {
	NumBytes    int64
	ElapsedTime int64
}

AppInfo contains an application level measurement. This structure is described in the ndt7 specification.

type ArchivalData

type ArchivalData struct {
	UUID               string
	StartTime          time.Time
	EndTime            time.Time
	ServerMeasurements []Measurement
	ClientMeasurements []Measurement
	ClientMetadata     []metadata.NameValue `json:",omitempty"`
}

ArchivalData saves all instantaneous measurements over the lifetime of a test.

type BBRInfo

type BBRInfo struct {
	ElapsedTime  int64
	MaxBandwidth int64
	MinRTT       int64
}

The BBRInfo struct contains information measured using BBR. This structure is an extension to the ndt7 specification. Variables here have the same measurement unit that is used by the Linux kernel.

type ConnectionInfo

type ConnectionInfo struct {
	Client string
	Server string
	UUID   string `json:",omitempty"`
}

ConnectionInfo contains connection info. This structure is described in the ndt7 specification.

type Measurement

type Measurement struct {
	AppInfo        *AppInfo        `json:",omitempty"`
	ConnectionInfo *ConnectionInfo `json:",omitempty" bigquery:"-"`
	BBRInfo        *BBRInfo        `json:",omitempty"`
	TCPInfo        *TCPInfo        `json:",omitempty"`
}

The Measurement struct contains measurement results. This structure is meant to be serialised as JSON as sent as a textual message. This structure is specified in the ndt7 specification.

type TCPInfo

type TCPInfo struct {
	tcp.LinuxTCPInfo
	ElapsedTime int64
}

The TCPInfo struct contains information measured using TCP_INFO. This structure is described in the ndt7 specification.