The trivial-timeout Reference Manual

This is the trivial-timeout Reference Manual, version 0.1.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:34:40 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-timeout

OS and Implementation independent access to timeouts

Maintainer

Gary Warren King <>

Author

Gary Warren King <>

License

MIT Style License

Version

0.1.5

Source

trivial-timeout.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 trivial-timeout/setup

Source

trivial-timeout.asd.

Parent Component

trivial-timeout (system).

Child Component

package.lisp (file).


3.2 trivial-timeout/timeout

Dependency

setup (module).

Source

trivial-timeout.asd.

Parent Component

trivial-timeout (system).

Child Component

with-timeout.lisp (file).


3.3 trivial-timeout/website

Source

trivial-timeout.asd.

Parent Component

trivial-timeout (system).

Child Component

source (module).


3.4 trivial-timeout/website/source

Source

trivial-timeout.asd.

Parent Component

website (module).

Child Component

index.mmd (file).


4 Files

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


4.1 Lisp


4.1.1 trivial-timeout/trivial-timeout.asd

Source

trivial-timeout.asd.

Parent Component

trivial-timeout (system).

ASDF Systems

trivial-timeout.

Packages

trivial-timeout-system.


4.1.2 trivial-timeout/setup/package.lisp

Source

trivial-timeout.asd.

Parent Component

setup (module).

Packages

com.metabang.trivial-timeout.


4.1.3 trivial-timeout/timeout/with-timeout.lisp

Source

trivial-timeout.asd.

Parent Component

timeout (module).

Public Interface
Internals

4.2 Static


4.2.1 trivial-timeout/website/source/index.mmd

Source

trivial-timeout.asd.

Parent Component

source (module).


5 Packages

Packages are listed by definition order.


5.1 com.metabang.trivial-timeout

Source

package.lisp.

Nickname

trivial-timeout

Use List

common-lisp.

Public Interface
Internals

5.2 trivial-timeout-system

Source

trivial-timeout.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: with-timeout ((seconds) &body body)

Execute ‘body‘ for no more than ‘seconds‘ time.

If ‘seconds‘ is exceeded, then a [timeout-error][] will be signaled.

If ‘seconds‘ is nil, then the body will be run normally until it completes or is interrupted.

Package

com.metabang.trivial-timeout.

Source

with-timeout.lisp.


6.1.2 Conditions

Condition: timeout-error

An error signaled when the duration specified in the [with-timeout][] is exceeded.

Package

com.metabang.trivial-timeout.

Source

with-timeout.lisp.

Direct superclasses

error.


6.2 Internals


6.2.1 Ordinary functions

Function: build-with-timeout (seconds body)
Package

com.metabang.trivial-timeout.

Source

with-timeout.lisp.

Function: generate-platform-specific-code (seconds-symbol doit-symbol)
Package

com.metabang.trivial-timeout.

Source

with-timeout.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables


A.4 Data types

Jump to:   C   F   I   M   P   S   T   W  
Index Entry  Section

C
com.metabang.trivial-timeout: The com․metabang․trivial-timeout package
Condition, timeout-error: Public conditions

F
File, index.mmd: The trivial-timeout/website/source/index․mmd file
File, package.lisp: The trivial-timeout/setup/package․lisp file
File, trivial-timeout.asd: The trivial-timeout/trivial-timeout․asd file
File, with-timeout.lisp: The trivial-timeout/timeout/with-timeout․lisp file

I
index.mmd: The trivial-timeout/website/source/index․mmd file

M
Module, setup: The trivial-timeout/setup module
Module, source: The trivial-timeout/website/source module
Module, timeout: The trivial-timeout/timeout module
Module, website: The trivial-timeout/website module

P
Package, com.metabang.trivial-timeout: The com․metabang․trivial-timeout package
Package, trivial-timeout-system: The trivial-timeout-system package
package.lisp: The trivial-timeout/setup/package․lisp file

S
setup: The trivial-timeout/setup module
source: The trivial-timeout/website/source module
System, trivial-timeout: The trivial-timeout system

T
timeout: The trivial-timeout/timeout module
timeout-error: Public conditions
trivial-timeout: The trivial-timeout system
trivial-timeout-system: The trivial-timeout-system package
trivial-timeout.asd: The trivial-timeout/trivial-timeout․asd file

W
website: The trivial-timeout/website module
with-timeout.lisp: The trivial-timeout/timeout/with-timeout․lisp file