The garbage-pools Reference Manual

This is the garbage-pools Reference Manual, version 0.1.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:17:41 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 garbage-pools

GARBAGE-POOLS is Common Lisp re-implementation of the APR Pools for resource management.

Author

Andrey Moskvitin <>

Home Page

https://github.com/archimag/garbage-pools

License

MIT

Version

0.1.2

Source

garbage-pools.asd.

Child Component

garbage-pools.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 garbage-pools/garbage-pools.asd

Source

garbage-pools.asd.

Parent Component

garbage-pools (system).

ASDF Systems

garbage-pools.

Packages

garbage-pools-asd.


3.1.2 garbage-pools/garbage-pools.lisp

Source

garbage-pools.asd.

Parent Component

garbage-pools (system).

Packages

garbage-pools.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 garbage-pools

Source

garbage-pools.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 garbage-pools-asd

Source

garbage-pools.asd.

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

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: defcleanup (class cleanup-fun)
Package

garbage-pools.

Source

garbage-pools.lisp.

Macro: with-garbage-pool ((&optional var) &body body)
Package

garbage-pools.

Source

garbage-pools.lisp.


5.1.2 Ordinary functions

Function: cancel-object-cleanup (object &optional pool)
Package

garbage-pools.

Source

garbage-pools.lisp.

Function: cleanup-object (object &optional pool)
Package

garbage-pools.

Source

garbage-pools.lisp.

Function: cleanup-pool (&optional pool)
Package

garbage-pools.

Source

garbage-pools.lisp.

Function: cleanup-register (object cleanup-fun &optional pool)
Package

garbage-pools.

Source

garbage-pools.lisp.


5.1.3 Generic functions

Generic Function: object-register (object &optional pool)
Package

garbage-pools.

Source

garbage-pools.lisp.

Methods
Method: object-register ((object stream) &optional pool)
Method: object-register ((object pool) &optional pool)
Method: object-register ((empty (eql nil)) &optional pool)

5.1.4 Classes

Class: pool
Package

garbage-pools.

Source

garbage-pools.lisp.

Direct methods
Direct slots
Slot: register-pairs
Readers

register-pairs.

Writers

(setf register-pairs).


5.2 Internals


5.2.1 Special variables

Special Variable: *pool*
Package

garbage-pools.

Source

garbage-pools.lisp.


5.2.2 Generic functions

Generic Reader: register-pairs (object)
Package

garbage-pools.

Methods
Reader Method: register-pairs ((pool pool))

automatically generated reader method

Source

garbage-pools.lisp.

Target Slot

register-pairs.

Generic Writer: (setf register-pairs) (object)
Package

garbage-pools.

Methods
Writer Method: (setf register-pairs) ((pool pool))

automatically generated writer method

Source

garbage-pools.lisp.

Target Slot

register-pairs.


Appendix A Indexes


A.1 Concepts


A.2 Functions


A.3 Variables