The cl-ntp-client Reference Manual

Table of Contents

The cl-ntp-client Reference Manual

This is the cl-ntp-client Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:35:38 2020 GMT+0.

1 Introduction

CL-NTP-CLIENT

A simple NTP (Network Time Protocol) client written in Common Lisp.

Does not adjust system clock, PLL drift or do any other platform specific work, nor does any statistical evaluation of time source or system clock jitter.

Usage

Instantiate an NTP object:

(defvar o (make-intance 'ntp))

Synchronize the object with NTP server:

(synchronize o)

After that, (get-adjusted-universal-time o) will return you a pair of NTP timestamp values: seconds and second fraction.

API

(synchronize ntp-instance &optional (server "pool.ntp.org"))

Synchronizes the application clock with remote server.

(get-adjusted-universal-time ntp-instance)

Returns application time as a pair of values, corresponding to universal time in seconds and NTP formatted 32-bit fraction of a second.

(local-stratum ntp-instance)

Returns the stratum of application clock.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-ntp-client

Author

Eugene Zaikonnikov

License

BSD

Description

A simple NTP (Network Time Protocol) client in Common Lisp

Dependencies

• alexandria
• usocket

Source

cl-ntp-client.asd (file)

Components

• package.lisp (file)
• cl-ntp-client.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-ntp-client.asd

Location

cl-ntp-client.asd

Systems

cl-ntp-client (system)

3.1.2 cl-ntp-client/package.lisp

Parent

cl-ntp-client (system)

Location

package.lisp

Packages

cl-ntp-client

3.1.3 cl-ntp-client/cl-ntp-client.lisp

Dependency

package.lisp (file)

Parent

cl-ntp-client (system)

Location

cl-ntp-client.lisp

Exported Definitions

• +micros+ (constant)
• +millis+ (constant)
• +nanos+ (constant)
• adjusted-big-time (method)
• big-time (macro)
• fraction-to-internal (function)
• fraction-to-seconds (function)
• fraction-to-usec (function)
• from-fraction (function)
• get-adjusted-universal-time (method)
• local-stratum (method)
• (setf local-stratum) (method)
• ntp (class)
• ntp-address (method)
• (setf ntp-address) (method)
• seconds-to-fraction (function)
• small-time (macro)
• sub-internal (function)
• synchronize (method)
• to-fraction (function)
• usec-to-fraction (function)

Internal Definitions

• buffer (method)
• delay-to-usec (function)
• leap-indicator (method)
• mode (method)
• (setf mode) (method)
• offset (method)
• (setf offset) (method)
• origtm-f (method)
• (setf origtm-f) (method)
• origtm-s (method)
• (setf origtm-s) (method)
• poll (method)
• precision (method)
• read32 (function)
• real-big-time (function)
• ref-id (method)
• reftm-f (method)
• reftm-s (method)
• root-delay (method)
• root-dispersion (method)
• run-server-exchange (method)
• rxtm-f (method)
• rxtm-s (method)
• stratum (method)
• txtm-f (method)
• txtm-s (method)
• version-number (method)
• (setf version-number) (method)
• write32 (function)

4 Packages

Packages are listed by definition order.

4.1 cl-ntp-client

Source

package.lisp (file)

Nickname

ntp

Use List

common-lisp

Exported Definitions

• +micros+ (constant)
• +millis+ (constant)
• +nanos+ (constant)
• adjusted-big-time (generic function)
• adjusted-big-time (method)
• big-time (macro)
• fraction-to-internal (function)
• fraction-to-seconds (function)
• fraction-to-usec (function)
• from-fraction (function)
• get-adjusted-universal-time (generic function)
• get-adjusted-universal-time (method)
• local-stratum (generic function)
• local-stratum (method)
• (setf local-stratum) (method)
• (setf local-stratum) (generic function)
• ntp (class)
• ntp-address (generic function)
• ntp-address (method)
• (setf ntp-address) (method)
• (setf ntp-address) (generic function)
• seconds-to-fraction (function)
• small-time (macro)
• sub-internal (function)
• synchronize (generic function)
• synchronize (method)
• to-fraction (function)
• usec-to-fraction (function)

Internal Definitions

• buffer (generic function)
• buffer (method)
• delay-to-usec (function)
• leap-indicator (generic function)
• leap-indicator (method)
• mode (generic function)
• mode (method)
• (setf mode) (method)
• (setf mode) (generic function)
• offset (generic function)
• offset (method)
• (setf offset) (method)
• (setf offset) (generic function)
• origtm-f (generic function)
• origtm-f (method)
• (setf origtm-f) (method)
• (setf origtm-f) (generic function)
• origtm-s (generic function)
• origtm-s (method)
• (setf origtm-s) (method)
• (setf origtm-s) (generic function)
• poll (generic function)
• poll (method)
• precision (generic function)
• precision (method)
• read32 (function)
• real-big-time (function)
• ref-id (generic function)
• ref-id (method)
• reftm-f (generic function)
• reftm-f (method)
• reftm-s (generic function)
• reftm-s (method)
• root-delay (generic function)
• root-delay (method)
• root-dispersion (generic function)
• root-dispersion (method)
• run-server-exchange (generic function)
• run-server-exchange (method)
• rxtm-f (generic function)
• rxtm-f (method)
• rxtm-s (generic function)
• rxtm-s (method)
• stratum (generic function)
• stratum (method)
• txtm-f (generic function)
• txtm-f (method)
• txtm-s (generic function)
• txtm-s (method)
• version-number (generic function)
• version-number (method)
• (setf version-number) (method)
• (setf version-number) (generic function)
• write32 (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Constants

Constant: +micros+

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Constant: +millis+

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Constant: +nanos+

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

5.1.2 Macros

Macro: big-time VALUES

Convert the NTP second/fraction value pair into a (large) integer

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Macro: small-time TIME

Convert the integer time representation back into NTP value pair domain

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

5.1.3 Functions

Function: fraction-to-internal FRACTION

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: fraction-to-seconds FRACTION

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: fraction-to-usec FRACTION

Fixed point conversion to microseconds

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: from-fraction FRACTION UNIT

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: seconds-to-fraction SECONDS

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: sub-internal FRACTION

Returns the remainder of ntp value less than internal-time-units-per-second

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: to-fraction TIME DIVISOR-UNIT

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: usec-to-fraction USEC

Fixed point conversion from microseconds

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

5.1.4 Generic functions

Generic Function: adjusted-big-time O

Package

cl-ntp-client

Methods

Method: adjusted-big-time (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: get-adjusted-universal-time O

Package

cl-ntp-client

Methods

Method: get-adjusted-universal-time (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: local-stratum OBJECT

Generic Function: (setf local-stratum) NEW-VALUE OBJECT

Package

cl-ntp-client

Methods

Method: local-stratum (NTP ntp)

automatically generated reader method

Source

cl-ntp-client.lisp (file)

Method: (setf local-stratum) NEW-VALUE (NTP ntp)

automatically generated writer method

Source

cl-ntp-client.lisp (file)

Generic Function: ntp-address OBJECT

Generic Function: (setf ntp-address) NEW-VALUE OBJECT

Package

cl-ntp-client

Methods

Method: ntp-address (NTP ntp)

automatically generated reader method

Source

cl-ntp-client.lisp (file)

Method: (setf ntp-address) NEW-VALUE (NTP ntp)

automatically generated writer method

Source

cl-ntp-client.lisp (file)

Generic Function: synchronize O &optional SERVER

Package

cl-ntp-client

Methods

Method: synchronize (O ntp) &optional SERVER

Source

cl-ntp-client.lisp (file)

5.1.5 Classes

Class: ntp ()

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• synchronize (method)
• run-server-exchange (method)
• get-adjusted-universal-time (method)
• adjusted-big-time (method)
• txtm-f (method)
• txtm-s (method)
• rxtm-f (method)
• rxtm-s (method)
• origtm-f (method)
• origtm-f (method)
• origtm-s (method)
• origtm-s (method)
• reftm-f (method)
• reftm-s (method)
• ref-id (method)
• root-dispersion (method)
• root-delay (method)
• precision (method)
• poll (method)
• stratum (method)
• mode (method)
• mode (method)
• version-number (method)
• version-number (method)
• leap-indicator (method)
• ntp-address (method)
• ntp-address (method)
• local-stratum (method)
• local-stratum (method)
• offset (method)
• offset (method)
• buffer (method)

Direct slots

Slot: buffer

Type

(quote (simple-array (unsigned-byte 8) (48)))

Initform

(make-array 48 :element-type (quote (unsigned-byte 8)) :initial-element 0)

Readers

buffer (generic function)

Slot: offset

Type

(quote integer)

Initform

(- (cl-ntp-client:big-time (values (get-universal-time) 0)) (cl-ntp-client::real-big-time))

Readers

offset (generic function)

Writers

(setf offset) (generic function)

Slot: local-stratum

Type

(quote integer)

Initform

8

Readers

local-stratum (generic function)

Writers

(setf local-stratum) (generic function)

Slot: address

Initform

:ntp-address

Readers

ntp-address (generic function)

Writers

(setf ntp-address) (generic function)

5.2 Internal definitions

5.2.1 Functions

Function: delay-to-usec DELAY

Scaled delay to microseconds conversion

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: read32 ARRAY POS

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: real-big-time ()

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

Function: write32 ARRAY POS VAL

Package

cl-ntp-client

Source

cl-ntp-client.lisp (file)

5.2.2 Generic functions

Generic Function: buffer OBJECT

Package

cl-ntp-client

Methods

Method: buffer (NTP ntp)

automatically generated reader method

Source

cl-ntp-client.lisp (file)

Generic Function: leap-indicator O

Package

cl-ntp-client

Methods

Method: leap-indicator (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: mode O

Generic Function: (setf mode) NEW-VALUE O

Package

cl-ntp-client

Methods

Method: mode (O ntp)

Method: (setf mode) NEW-VALUE (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: offset OBJECT

Generic Function: (setf offset) NEW-VALUE OBJECT

Package

cl-ntp-client

Methods

Method: offset (NTP ntp)

automatically generated reader method

Source

cl-ntp-client.lisp (file)

Method: (setf offset) NEW-VALUE (NTP ntp)

automatically generated writer method

Source

cl-ntp-client.lisp (file)

Generic Function: origtm-f O

Generic Function: (setf origtm-f) STAMP O

Package

cl-ntp-client

Methods

Method: origtm-f (O ntp)

Method: (setf origtm-f) STAMP (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: origtm-s O

Generic Function: (setf origtm-s) STAMP O

Package

cl-ntp-client

Methods

Method: origtm-s (O ntp)

Method: (setf origtm-s) STAMP (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: poll O

Package

cl-ntp-client

Methods

Method: poll (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: precision O

Package

cl-ntp-client

Methods

Method: precision (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: ref-id O

Package

cl-ntp-client

Methods

Method: ref-id (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: reftm-f O

Package

cl-ntp-client

Methods

Method: reftm-f (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: reftm-s O

Package

cl-ntp-client

Methods

Method: reftm-s (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: root-delay O

Package

cl-ntp-client

Methods

Method: root-delay (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: root-dispersion O

Package

cl-ntp-client

Methods

Method: root-dispersion (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: run-server-exchange O ADDRESS

Package

cl-ntp-client

Methods

Method: run-server-exchange (O ntp) ADDRESS

Communicates with remote server to return time offset from the local clock

Source

cl-ntp-client.lisp (file)

Generic Function: rxtm-f O

Package

cl-ntp-client

Methods

Method: rxtm-f (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: rxtm-s O

Package

cl-ntp-client

Methods

Method: rxtm-s (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: stratum O

Package

cl-ntp-client

Methods

Method: stratum (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: txtm-f O

Package

cl-ntp-client

Methods

Method: txtm-f (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: txtm-s O

Package

cl-ntp-client

Methods

Method: txtm-s (O ntp)

Source

cl-ntp-client.lisp (file)

Generic Function: version-number O

Generic Function: (setf version-number) NEW-VALUE O

Package

cl-ntp-client

Methods

Method: version-number (O ntp)

Method: (setf version-number) NEW-VALUE (O ntp)

Source

cl-ntp-client.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types