results

Documentation

Overview

Package results contains server results

Index

• type File
  • func OpenFor(request *http.Request, conn *websocket.Conn, datadir string, ...) (*File, error)
  • func (fp *File) Close() error
  • func (fp *File) WriteMeasurement(measurement model.Measurement, origin string) error
  • func (fp *File) WriteMetadata(metadata metadata) error

Types

type File

type File struct {
	// Writer is the gzip writer instance
	Writer *gzip.Writer

	// Fp is the underlying file
	Fp *os.File
}

File is the file where we save measurements.

func OpenFor

func OpenFor(request *http.Request, conn *websocket.Conn, datadir string, what spec.SubtestKind) (*File, error)

OpenFor opens the results file and writes into it the results metadata based on the query string. Returns the results file on success. Returns an error in case of failure. The request argument is used to get the query string containing the metadata. The conn argument is used to retrieve the local and the remote endpoints addresses. The "datadir" argument specifies the directory on disk to write the data into and the what argument should indicate whether this is a spec.SubtestDownload or a spec.SubtestUpload ndt7 measurement.

func (*File) Close

func (fp *File) Close() error

Close closes the measurement file.

func (*File) WriteMeasurement

func (fp *File) WriteMeasurement(measurement model.Measurement, origin string) error

WriteMeasurement writes |measurement| on the measurements file.

func (*File) WriteMetadata

func (fp *File) WriteMetadata(metadata metadata) error

WriteMetadata writes |metadata| on the measurements file.