spec

Documentation

Overview

Package spec contains constants for the ndt-m protocol. More information can be found in the ndt7 protocol spec, of which ndt-m is an extension.

Index

• Constants
• type SubtestKind

Constants

const (
	// MinMessagesize is the minimum size of a Websocket binary message during
	// an ndt-m test.
	MinMessageSize = 1 << 10

	// MaxMessageSize is the minimum value of the maximum message size
	// that an implementation MAY want to configure. Messages smaller than this
	// threshold MUST always be accepted by an implementation.
	MaxMessageSize = 1 << 24

	// MaxScaledMessageSize is the maximum value of a scaled binary WebSocket
	// message size. This should be <= of MaxScaledMessageSize. The 1<<20 value is
	// a good compromise between Go and JavaScript as seen in cloud based tests.
	MaxScaledMessageSize = 1 << 20

	// MinMeasureInterval is the minimum interval between subsequent measurements.
	MinMeasureInterval = 100 * time.Millisecond

	// AvgMeasureInterval is the average interval between subsequent measurements.
	AvgMeasureInterval = 250 * time.Millisecond

	// MaxMeasureInterval is the maximum interval between subsequent measurements.
	MaxMeasureInterval = 400 * time.Millisecond

	// ScalingFraction sets the threshold for scaling binary messages. When
	// the current binary message size is <= than 1/scalingFactor of the
	// amount of bytes sent so far, we scale the message. This is documented
	// in the appendix of the ndt7 specification.
	ScalingFraction = 16

	// DownloadPath selects the download subtest.
	DownloadPath = "/msak/ndtm/download"
	// UploadPath selects the upload subtest.
	UploadPath = "/msak/ndtm/upload"

	// MaxRuntime is the maximum runtime of a subtest.
	MaxRuntime = 15 * time.Second

	// SecWebSocketProtocol is the value of the Sec-WebSocket-Protocol header.
	SecWebSocketProtocol = "net.measurementlab.ndt.m"
)

const (
	// SubtestDownload is a download subtest
	SubtestDownload = SubtestKind("download")

	// SubtestUpload is a upload subtest
	SubtestUpload = SubtestKind("upload")
)

Types

type SubtestKind

type SubtestKind string

SubtestKind indicates the subtest kind