The trivial-timeout Reference Manual

Table of Contents

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

The trivial-timeout Reference Manual

This is the trivial-timeout Reference Manual, version 0.1.5, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:27:53 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

trivial-timeout

portable and possibly dangerous timeout library for Common Lisp


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 trivial-timeout

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Gary Warren King <gwking@metabang.com>

License

MIT Style License

Description

OS and Implementation independent access to timeouts

Version

0.1.5

Source

trivial-timeout.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 trivial-timeout/setup

Parent

trivial-timeout (system)

Location

dev/

Component

package.lisp (file)


Next: , Previous: , Up: Modules   [Contents][Index]

3.2 trivial-timeout/timeout

Dependency

setup (module)

Parent

trivial-timeout (system)

Location

dev/

Component

with-timeout.lisp (file)


Next: , Previous: , Up: Modules   [Contents][Index]

3.3 trivial-timeout/website

Parent

trivial-timeout (system)

Location

website/

Component

source (module)


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

3.4 trivial-timeout/website/source

Parent

website (module)

Location

website/source/

Component

index.mmd (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 trivial-timeout.asd

Location

trivial-timeout.asd

Systems

trivial-timeout (system)

Packages

trivial-timeout-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 trivial-timeout/setup/package.lisp

Parent

setup (module)

Location

dev/package.lisp

Packages

com.metabang.trivial-timeout


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

timeout (module)

Location

dev/with-timeout.lisp

Exported Definitions
Internal Definitions

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

4.2 Other


Previous: , Up: Other files   [Contents][Index]

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

Parent

source (module)

Location

website/source/index.mmd


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


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

5.1 trivial-timeout-system

Source

trivial-timeout.asd

Use List

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

5.2 com.metabang.trivial-timeout

Source

package.lisp (file)

Nickname

trivial-timeout

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Direct superclasses

error (condition)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: build-with-timeout SECONDS BODY
Package

com.metabang.trivial-timeout

Source

with-timeout.lisp (file)

Function: generate-platform-specific-code SECONDS-SYMBOL DOIT-SYMBOL
Package

com.metabang.trivial-timeout

Source

with-timeout.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   O   T  
Index Entry  Section

F
File, Lisp, trivial-timeout.asd: The trivial-timeout<dot>asd file
File, Lisp, trivial-timeout/setup/package.lisp: The trivial-timeout/setup/package<dot>lisp file
File, Lisp, trivial-timeout/timeout/with-timeout.lisp: The trivial-timeout/timeout/with-timeout<dot>lisp file
File, other, trivial-timeout/website/source/index.mmd: The trivial-timeout/website/source/index<dot>mmd file

L
Lisp File, trivial-timeout.asd: The trivial-timeout<dot>asd file
Lisp File, trivial-timeout/setup/package.lisp: The trivial-timeout/setup/package<dot>lisp file
Lisp File, trivial-timeout/timeout/with-timeout.lisp: The trivial-timeout/timeout/with-timeout<dot>lisp file

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

O
Other File, trivial-timeout/website/source/index.mmd: The trivial-timeout/website/source/index<dot>mmd file

T
trivial-timeout.asd: The trivial-timeout<dot>asd file
trivial-timeout/setup: The trivial-timeout/setup module
trivial-timeout/setup/package.lisp: The trivial-timeout/setup/package<dot>lisp file
trivial-timeout/timeout: The trivial-timeout/timeout module
trivial-timeout/timeout/with-timeout.lisp: The trivial-timeout/timeout/with-timeout<dot>lisp file
trivial-timeout/website: The trivial-timeout/website module
trivial-timeout/website/source: The trivial-timeout/website/source module
trivial-timeout/website/source/index.mmd: The trivial-timeout/website/source/index<dot>mmd file

Jump to:   F   L   M   O   T  

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

A.2 Functions

Jump to:   B   F   G   M   W  
Index Entry  Section

B
build-with-timeout: Internal functions

F
Function, build-with-timeout: Internal functions
Function, generate-platform-specific-code: Internal functions

G
generate-platform-specific-code: Internal functions

M
Macro, with-timeout: Exported macros

W
with-timeout: Exported macros

Jump to:   B   F   G   M   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S   T  
Index Entry  Section

C
com.metabang.trivial-timeout: The com<dot>metabang<dot>trivial-timeout package
Condition, timeout-error: Exported conditions

P
Package, com.metabang.trivial-timeout: The com<dot>metabang<dot>trivial-timeout package
Package, trivial-timeout-system: The trivial-timeout-system package

S
System, trivial-timeout: The trivial-timeout system

T
timeout-error: Exported conditions
trivial-timeout: The trivial-timeout system
trivial-timeout-system: The trivial-timeout-system package

Jump to:   C   P   S   T