Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The trivial-clock Reference Manual

This is the trivial-clock Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:28:40 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The trivial-clock Reference Manual, Up: The trivial-clock Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The trivial-clock Reference Manual [Contents][Index]

2 Systems

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

trivial-clock

Previous: Systems, Up: Systems [Contents][Index]

2.1 `trivial-clock`

Common Lisp library to get accurate wall-clock times on multiple platforms

Author: Ákos Kiss <ak@coram.pub>
License: MIT License
Dependency: cffi (system).
Source: trivial-clock.asd.
Child Component: trivial-clock.lisp (file).

Next: Packages, Previous: Systems, Up: The trivial-clock Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

trivial-clock/trivial-clock.asd
trivial-clock/trivial-clock.lisp

Next: trivial-clock/trivial-clock.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `trivial-clock/trivial-clock.asd`

Source: trivial-clock.asd.
Parent Component: trivial-clock (system).
ASDF Systems: trivial-clock.

Previous: trivial-clock/trivial-clock.asd, Up: Lisp [Contents][Index]

3.1.2 `trivial-clock/trivial-clock.lisp`

Source

trivial-clock.asd.

Parent Component

trivial-clock (system).

Packages

trivial-clock.

Public Interface

+universal-time-epoch-offset+ (constant).
now (function).

Internals

clock-gettime (function).
timespec-tclass (class).

Next: Definitions, Previous: Files, Up: The trivial-clock Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

trivial-clock

Previous: Packages, Up: Packages [Contents][Index]

4.1 `trivial-clock`

Source

trivial-clock.lisp.

Use List

common-lisp.

Public Interface

+universal-time-epoch-offset+ (constant).
now (function).

Internals

clock-gettime (function).
timespec-tclass (class).

Next: Indexes, Previous: Packages, Up: The trivial-clock Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Constants
Ordinary functions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Constants

Constant: +universal-time-epoch-offset+ ¶

Package: trivial-clock.
Source: trivial-clock.lisp.

Previous: Constants, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: now () ¶

Query OS for current wall-clock time

Returns number of seconds since the unix epoch and the number of additional nanoseconds as a second value.

Package: trivial-clock.
Source: trivial-clock.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions
Classes

Next: Classes, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: clock-gettime (clock-id out-timespec) ¶

Package: trivial-clock.
Source: trivial-clock.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.2 Classes

Class: timespec-tclass ¶

Package

trivial-clock.

Source

trivial-clock.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Previous: Definitions, Up: The trivial-clock Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	C F N

	Index Entry		Section

C
	`clock-gettime`:		Private ordinary functions

F
	`Function, clock-gettime`:		Private ordinary functions
	`Function, now`:		Public ordinary functions

N
	`now`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ C

	Index Entry		Section

+
	`+universal-time-epoch-offset+`:		Public constants

C
	`Constant, +universal-time-epoch-offset+`:		Public constants

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F P S T

	Index Entry		Section

C
	`Class, timespec-tclass`:		Private classes

F
	`File, trivial-clock.asd`:		The trivial-clock/trivial-clock․asd file
	`File, trivial-clock.lisp`:		The trivial-clock/trivial-clock․lisp file

P
	`Package, trivial-clock`:		The trivial-clock package

S
	`System, trivial-clock`:		The trivial-clock system

T
	`timespec-tclass`:		Private classes
	`trivial-clock`:		The trivial-clock system
	`trivial-clock`:		The trivial-clock package
	`trivial-clock.asd`:		The trivial-clock/trivial-clock․asd file
	`trivial-clock.lisp`:		The trivial-clock/trivial-clock․lisp file