The precise-time Reference Manual

This is the precise-time Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:20:19 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 precise-time

Precise time measurements

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/precise-time/

Source Control

(GIT https://github.com/shinmera/precise-time.git)

Bug Tracker

https://github.com/shinmera/precise-time/issues

License

zlib

Version

1.0.0

Defsystem Dependency

trivial-features (system).

Dependencies
  • documentation-utils (system).
  • cffi (system)., for feature (:not :mezzano)
Source

precise-time.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 precise-time/precise-time.asd

Source

precise-time.asd.

Parent Component

precise-time (system).

ASDF Systems

precise-time.


3.1.2 precise-time/package.lisp

Source

precise-time.asd.

Parent Component

precise-time (system).

Packages

org.shirakumo.precise-time.


3.1.3 precise-time/protocol.lisp

Dependency

package.lisp (file).

Source

precise-time.asd.

Parent Component

precise-time (system).

Public Interface
Internals

3.1.4 precise-time/posix.lisp

If Feature

(:and :unix (:not :darwin))

Dependency

protocol.lisp (file).

Source

precise-time.asd.

Parent Component

precise-time (system).

Public Interface
Internals

3.1.5 precise-time/darwin.lisp

If Feature

:darwin

Dependencies
Source

precise-time.asd.

Parent Component

precise-time (system).


3.1.6 precise-time/windows.lisp

If Feature

:windows

Dependencies
Source

precise-time.asd.

Parent Component

precise-time (system).


3.1.7 precise-time/mezzano.lisp

If Feature

:mezzano

Dependencies
Source

precise-time.asd.

Parent Component

precise-time (system).


3.1.8 precise-time/nx.lisp

If Feature

:nx

Dependencies
Source

precise-time.asd.

Parent Component

precise-time (system).


3.1.9 precise-time/documentation.lisp

Dependencies
Source

precise-time.asd.

Parent Component

precise-time (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.precise-time

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Symbol macros

Symbol Macro: monotonic-time-units-per-second
Package

org.shirakumo.precise-time.

Source

protocol.lisp.

Symbol Macro: precise-time-units-per-second
Package

org.shirakumo.precise-time.

Source

protocol.lisp.


5.1.2 Ordinary functions

Function: get-monotonic-time ()

Gets a monotonically increasing time with as much precision as possible.

Returns two values:
- A number of seconds since an arbitrary, but fixed epoch
- The number of sub-seconds in units of MONOTONIC-TIME-UNITS-PER-SECOND

The time returned does not jump forwards or backwards regardless of system clock and will always remain monotonically increasing.

Signals an error of type QUERY-FAILED if the time could not be fetched for whatever reason.

See MONOTONIC-TIME-UNITS-PER-SECOND
See QUERY-FAILED

Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: get-precise-time ()

Gets the current time with as much precision as possible.

Returns two values:
- A universal-time timestamp
- The number of sub-seconds in units of PRECISE-TIME-UNITS-PER-SECOND

The time returned *may* jump forwards or backwards if the system clock is adjusted.

Signals an error of type QUERY-FAILED if the time could not be fetched for whatever reason.

See PRECISE-TIME-UNITS-PER-SECOND
See QUERY-FAILED

Package

org.shirakumo.precise-time.

Source

posix.lisp.


5.1.3 Conditions

Condition: query-failed

Error signalled if a timer couldn’t be fetched.

Package

org.shirakumo.precise-time.

Source

protocol.lisp.

Direct superclasses

error.

Direct slots
Slot: function
Package

common-lisp.

Initform

(quote nil)

Initargs

:function

Slot: message
Initform

(quote nil)

Initargs

:message


5.2 Internals


5.2.1 Macros

Macro: define-constant (name value)
Package

org.shirakumo.precise-time.

Source

protocol.lisp.

Macro: define-implementation (fun args &body body)
Package

org.shirakumo.precise-time.

Source

protocol.lisp.

Macro: define-protocol-constant (name type &body default)
Package

org.shirakumo.precise-time.

Source

protocol.lisp.

Macro: define-protocol-fun (name args vals &body default)
Package

org.shirakumo.precise-time.

Source

protocol.lisp.


5.2.2 Ordinary functions

Function: %monotonic-time-units-per-second ()
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: %precise-time-units-per-second ()
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: timespec-nsecs (pointer-to-timespec)
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: (setf timespec-nsecs) (pointer-to-timespec)
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: timespec-secs (pointer-to-timespec)
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Function: (setf timespec-secs) (pointer-to-timespec)
Package

org.shirakumo.precise-time.

Source

posix.lisp.


5.2.3 Classes

Class: timespec-tclass
Package

org.shirakumo.precise-time.

Source

posix.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.4 Data types

Jump to:   C   D   F   M   N   O   P   Q   S   T   W  
Index Entry  Section

C
Class, timespec-tclass: Private classes
Condition, query-failed: Public conditions

D
darwin.lisp: The precise-time/darwin․lisp file
documentation.lisp: The precise-time/documentation․lisp file

F
File, darwin.lisp: The precise-time/darwin․lisp file
File, documentation.lisp: The precise-time/documentation․lisp file
File, mezzano.lisp: The precise-time/mezzano․lisp file
File, nx.lisp: The precise-time/nx․lisp file
File, package.lisp: The precise-time/package․lisp file
File, posix.lisp: The precise-time/posix․lisp file
File, precise-time.asd: The precise-time/precise-time․asd file
File, protocol.lisp: The precise-time/protocol․lisp file
File, windows.lisp: The precise-time/windows․lisp file

M
mezzano.lisp: The precise-time/mezzano․lisp file

N
nx.lisp: The precise-time/nx․lisp file

O
org.shirakumo.precise-time: The org․shirakumo․precise-time package

P
Package, org.shirakumo.precise-time: The org․shirakumo․precise-time package
package.lisp: The precise-time/package․lisp file
posix.lisp: The precise-time/posix․lisp file
precise-time: The precise-time system
precise-time.asd: The precise-time/precise-time․asd file
protocol.lisp: The precise-time/protocol․lisp file

Q
query-failed: Public conditions

S
System, precise-time: The precise-time system

T
timespec-tclass: Private classes

W
windows.lisp: The precise-time/windows․lisp file