ntp

package

v1.6.1 Latest Latest Go to latest Published: Nov 28, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Checker represents a NTP checker that periodically checks the system time against the network time.

func NewNtpChecker(opts ...CheckerOption) *Checker

NewNtpChecker creates a new Checker with the provided options. If no options are provided, it uses default values for interval and threshold.

func (c *Checker) ClockOffset() (time.Duration, error)

func (c *Checker) IsOutOfSync() bool

func (c *Checker) Start()

func (c *Checker) Stop()

type CheckerOption func(*Checker)

CheckerOption defines the type for functions that configure a Checker.

func WithInterval(interval time.Duration) CheckerOption

WithInterval sets the interval at which the checker will run. Default interval is 1 minute.

func WithQuerier(querier Querier) CheckerOption

WithQuerier sets the Querier for the Checker.

func WithThreshold(threshold time.Duration) CheckerOption

WithThreshold sets the threshold for determining if the system time is out of sync. Default threshold is 1 second.

type Querier interface {
	Query(address string) (*ntp.Response, error)
}

type QueryError struct{}

QueryError is returned when a query from all NTP pools encounters an error and we have no valid response from them.

func (QueryError) Error() string

type RemoteQuerier struct{}

func (RemoteQuerier) Query(address string) (*ntp.Response, error)