clock

Documentation

Index

• Constants
• func Worst(points []*DataPoint, accuracyExpr, classExpr string) (*ptp.ClockQuality, error)
• type DataPoint
  • func Run() (*DataPoint, error)
• type RingBuffer
  • func NewRingBuffer(size int) *RingBuffer
  • func (rb *RingBuffer) Data() []*DataPoint
  • func (rb *RingBuffer) Write(c *DataPoint)

Constants

const (
	// ClockClassLock is a class representing locked state
	ClockClassLock ptp.ClockClass = ptp.ClockClass6
	// ClockClassHoldover is a class representing holdover state
	ClockClassHoldover ptp.ClockClass = ptp.ClockClass7
	// ClockClassCalibrating is a class representing calibrating state
	ClockClassCalibrating ptp.ClockClass = ptp.ClockClass13
	// ClockClassUncalibrated is a class representing uncalibrated state
	ClockClassUncalibrated ptp.ClockClass = ptp.ClockClass52
)

Functions

func Worst

func Worst(points []*DataPoint, accuracyExpr, classExpr string) (*ptp.ClockQuality, error)

Worst finding worst case clock quality from supplied data points

Types

type DataPoint

type DataPoint struct {
	PHCOffset            time.Duration
	OscillatorOffset     time.Duration
	OscillatorClockClass ptp.ClockClass
}

DataPoint representing a sample of data used in clock class/accuracy calculations

func Run

func Run() (*DataPoint, error)

Run the data point collection

type RingBuffer

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

RingBuffer is a ring buffer of ClockQuality data

func NewRingBuffer

func NewRingBuffer(size int) *RingBuffer

NewRingBuffer creates new RingBuffer of a defined size

func (*RingBuffer) Data

func (rb *RingBuffer) Data() []*DataPoint

Data from the ring buffer

func (*RingBuffer) Write

func (rb *RingBuffer) Write(c *DataPoint)

Write new element to a ring buffer