measurer

Documentation

Overview

Package measurer collects metrics from a socket connection and returns them for consumption.

Index

• type Measurer
  • func New(conn *websocket.Conn, UUID string) *Measurer
  • func (m *Measurer) Start(ctx context.Context, timeout time.Duration) <-chan model.Measurement
  • func (m *Measurer) Stop(src <-chan model.Measurement)

Types

type Measurer

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

Measurer performs measurements

func New

func New(conn *websocket.Conn, UUID string) *Measurer

New creates a new measurer instance

func (*Measurer) Start

func (m *Measurer) Start(ctx context.Context, timeout time.Duration) <-chan model.Measurement

Start runs the measurement loop in a background goroutine and emits the measurements on the returned channel.

Liveness guarantee: the measurer will always terminate after the given timeout, provided that the consumer continues reading from the returned channel. Measurer may be stopped early by canceling ctx, or by calling Stop.

func (*Measurer) Stop

func (m *Measurer) Stop(src <-chan model.Measurement)

Stop ends the measurements and drains the measurement channel. Stop guarantees that the measurement goroutine completes by draining the measurement channel. Users that call Start should also call Stop.