The garbage-pools Reference Manual

Table of Contents

The garbage-pools Reference Manual

This is the garbage-pools Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:32:21 2020 GMT+0.

1 Systems

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

1.1 garbage-pools

Source

garbage-pools.asd (file)

Component

garbage-pools.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 garbage-pools.asd

Location

garbage-pools.asd

Systems

garbage-pools (system)

2.1.2 garbage-pools/garbage-pools.lisp

Parent

garbage-pools (system)

Location

garbage-pools.lisp

Packages

garbage-pools

Exported Definitions

• cancel-object-cleanup (function)
• cleanup-object (function)
• cleanup-pool (function)
• cleanup-register (function)
• defcleanup (macro)
• object-register (generic function)
• object-register (method)
• object-register (method)
• object-register (method)
• pool (class)
• with-garbage-pool (macro)

Internal Definitions

• *pool* (special variable)
• register-pairs (method)
• (setf register-pairs) (method)

3 Packages

Packages are listed by definition order.

3.1 garbage-pools

Source

garbage-pools.lisp (file)

Use List

common-lisp

Exported Definitions

• cancel-object-cleanup (function)
• cleanup-object (function)
• cleanup-pool (function)
• cleanup-register (function)
• defcleanup (macro)
• object-register (generic function)
• object-register (method)
• object-register (method)
• object-register (method)
• pool (class)
• with-garbage-pool (macro)

Internal Definitions

• *pool* (special variable)
• register-pairs (generic function)
• register-pairs (method)
• (setf register-pairs) (method)
• (setf register-pairs) (generic function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: defcleanup CLASS CLEANUP-FUN

Package

garbage-pools

Source

garbage-pools.lisp (file)

Macro: with-garbage-pool (&optional VAR) &body BODY

Package

garbage-pools

Source

garbage-pools.lisp (file)

4.1.2 Functions

Function: cancel-object-cleanup OBJECT &optional POOL

Package

garbage-pools

Source

garbage-pools.lisp (file)

Function: cleanup-object OBJECT &optional POOL

Package

garbage-pools

Source

garbage-pools.lisp (file)

Function: cleanup-pool &optional POOL

Package

garbage-pools

Source

garbage-pools.lisp (file)

Function: cleanup-register OBJECT CLEANUP-FUN &optional POOL

Package

garbage-pools

Source

garbage-pools.lisp (file)

4.1.3 Generic functions

Generic Function: object-register OBJECT &optional POOL

Package

garbage-pools

Source

garbage-pools.lisp (file)

Methods

Method: object-register (OBJECT stream) &optional POOL

Method: object-register (OBJECT pool) &optional POOL

Method: object-register (EMPTY (eql nil)) &optional POOL

4.1.4 Classes

Class: pool ()

Package

garbage-pools

Source

garbage-pools.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• object-register (method)
• register-pairs (method)
• register-pairs (method)

Direct slots

Slot: register-pairs

Readers

register-pairs (generic function)

Writers

(setf register-pairs) (generic function)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *pool*

Package

garbage-pools

Source

garbage-pools.lisp (file)

4.2.2 Generic functions

Generic Function: register-pairs OBJECT

Generic Function: (setf register-pairs) NEW-VALUE OBJECT

Package

garbage-pools

Methods

Method: register-pairs (POOL pool)

automatically generated reader method

Source

garbage-pools.lisp (file)

Method: (setf register-pairs) NEW-VALUE (POOL pool)

automatically generated writer method

Source

garbage-pools.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types