spec

Documentation

Overview

Package spec contains constants defined in the ndt7 specification.

Index

• Constants
• type SubtestKind

Constants

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

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

const AveragePoissonSamplingInterval = 250 * time.Millisecond

AveragePoissonSamplingInterval is the average of a lambda distribution used to decide when to perform next measurement.

const DefaultRuntime = 10 * time.Second

DefaultRuntime is the default runtime of a subtest

const DefaultWebsocketBufferSize = 1 << 20

DefaultWebsocketBufferSize is the read and write buffer sizes used when creating a websocket connection. This size is independent of the websocket message sizes defined above (which may be larger) and used to optimize read and write operations. However, larger buffers will practically limit the total number of concurrent connections possible. We use 1MB as a balance.

const DownloadURLPath = "/ndt/v7/download"

DownloadURLPath selects the download subtest.

const MaxMessageSize = 1 << 24

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.

const MaxPoissonSamplingInterval = 625 * time.Millisecond

MaxPoissonSamplingInterval is the max acceptable time that we want the lambda distribution to return. Bigger values will be clamped to be this value instead.

const MaxRuntime = 15 * time.Second

MaxRuntime is the maximum runtime of a subtest

const MaxScaledMessageSize = 1 << 20

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

const MinPoissonSamplingInterval = 25 * time.Millisecond

MinPoissonSamplingInterval is the min acceptable time that we want the lambda distribution to return. Smaller values will be clamped to be this value instead.

const ScalingFraction = 16

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.

const SecWebSocketProtocol = "net.measurementlab.ndt.v7"

SecWebSocketProtocol is the WebSocket subprotocol used by ndt7.

const UploadURLPath = "/ndt/v7/upload"

UploadURLPath selects the upload subtest.

Types

type SubtestKind

type SubtestKind string

SubtestKind indicates the subtest kind