speedtest

README

gospeedtest

Documentation

Index

• func RunSpeedTest()
• type BytesPerTime
• type Direction
• type SpeedTest
  • func NewSpeedTest(connection net.Conn, direction Direction) *SpeedTest
  • func (sp *SpeedTest) ReceiveData() error
  • func (sp *SpeedTest) SendData()
  • func (sp *SpeedTest) SpeedAggregator()
• type SpeedTestControl
• type SpeedTestResult
• type SpeedTestStatus
• type Status

Functions

func RunSpeedTest

func RunSpeedTest()

Types

type BytesPerTime

type BytesPerTime struct {
	Bytes uint
	Time  time.Duration
}

type Direction

type Direction int

const (
	DirectionDown Direction = iota
	DirectionUp
)

type SpeedTest

type SpeedTest struct {
	Result         SpeedTestResult
	ReportChan     chan BytesPerTime
	Connection     net.Conn
	StatusChan     chan SpeedTestStatus
	DataStreamChan chan BytesPerTime // The raw stream used to report bytes per time on each send of bytes.
	ControlChan    chan SpeedTestControl
	TestComplete   bool
	Direction      Direction
	Duration       int
}

func NewSpeedTest

func NewSpeedTest(connection net.Conn, direction Direction) *SpeedTest

func (*SpeedTest) ReceiveData

func (sp *SpeedTest) ReceiveData() error

func (*SpeedTest) SendData

func (sp *SpeedTest) SendData()

func (*SpeedTest) SpeedAggregator

func (sp *SpeedTest) SpeedAggregator()

type SpeedTestControl

type SpeedTestControl int

const (
	ControlStart SpeedTestControl = iota
	ControlStop
	ControlAbort
)

type SpeedTestResult

type SpeedTestResult struct {
	Duration         time.Duration
	BytesTransferred uint
	AverageSpeed     uint
	PeakSpeed        uint
	InitialPing      *ping.Statistics
	DuringPing       *ping.Statistics
	AfterPing        *ping.Statistics
	BufferBloat      uint // Buffer bloat in ms
}

type SpeedTestStatus

type SpeedTestStatus struct {
	Error  error
	Status Status
}

type Status

type Status int

const (
	StatusReady Status = iota
	StatusStarted
	StatusRunningInitialPings
	StatusRunningFinalPings
	StatusFinished
	StatusAborted
)