throughput1

Documentation

Index

• func Upgrade(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)
• type Measurer
• type Protocol
  • func New(conn *websocket.Conn) *Protocol
  • func (p *Protocol) ReceiverLoop(ctx context.Context) (<-chan model.WireMeasurement, <-chan model.WireMeasurement, <-chan error)
  • func (p *Protocol) ScaleMessage(msgSize int, bytesSent int) int
  • func (p *Protocol) SenderLoop(ctx context.Context) (<-chan model.WireMeasurement, <-chan model.WireMeasurement, <-chan error)
  • func (p *Protocol) SetByteLimit(value int)

Functions

func Upgrade

func Upgrade(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)

Upgrade takes a HTTP request and upgrades the connection to WebSocket. Returns a websocket Conn if the upgrade succeeded, and an error otherwise.

Types

type Measurer

type Measurer interface {
	Start(context.Context, net.Conn) <-chan model.Measurement
	Measure(ctx context.Context) model.Measurement
}

Measurer is an interface for collecting connection metrics.

type Protocol

type Protocol struct {
	// contains filtered or unexported fields
}

Protocol is the implementation of the throughput1 protocol.

func New

func New(conn *websocket.Conn) *Protocol

New returns a new Protocol with the specified connection and every other option set to default.

func (*Protocol) ReceiverLoop

func (p *Protocol) ReceiverLoop(ctx context.Context) (<-chan model.WireMeasurement,
	<-chan model.WireMeasurement, <-chan error)

ReceiverLoop starts the receiver loop of the throughput1 protocol. The context's lifetime determines how long to run for. It returns one channel for sender-side measurements, one channel for receiver-side measurements and one channel for errors. While the measurements channels could be ignored, the errors channel MUST be drained by the caller.

func (*Protocol) ScaleMessage

func (p *Protocol) ScaleMessage(msgSize int, bytesSent int) int

ScaleMessage sets the binary message size taking into consideration byte limits.

func (*Protocol) SenderLoop

func (p *Protocol) SenderLoop(ctx context.Context) (<-chan model.WireMeasurement,
	<-chan model.WireMeasurement, <-chan error)

SenderLoop starts the send loop of the throughput1 protocol. The context's lifetime determines how long to run for. It returns one channel for sender-side measurements, one channel for receiver-side measurements and one channel for errors. While the measurements channels could be ignored, the errors channel MUST be drained by the caller.

func (*Protocol) SetByteLimit

func (p *Protocol) SetByteLimit(value int)

SetByteLimit sets the number of bytes sent after which a test (either download or upload) will stop. Set the value to zero to disable the byte limit.