The clsql-fluid Reference Manual

This is the clsql-fluid Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:50:13 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clsql-fluid

Common Lisp SQL Fluid Connection Pools

Maintainer

Kevin M. Rosenberg <>

Author

Stephen Compall <>

License

Lessor Lisp General Public License

Long Description

A full database type based on fluids, or per-thread connections.

Dependencies
  • clsql (system).
  • closer-mop (system).
  • bordeaux-threads (system).
Source

clsql-fluid.asd.

Child Component

sql (module).


3 Modules

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


3.1 clsql-fluid/sql

Source

clsql-fluid.asd.

Parent Component

clsql-fluid (system).

Child Component

base (module).


3.2 clsql-fluid/sql/base

Source

clsql-fluid.asd.

Parent Component

sql (module).

Child Component

fluid.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 clsql-fluid/clsql-fluid.asd

Source

clsql-fluid.asd.

Parent Component

clsql-fluid (system).

ASDF Systems

clsql-fluid.

Packages

clsql-fluid-system.


4.1.2 clsql-fluid/sql/base/fluid.lisp

Source

clsql-fluid.asd.

Parent Component

base (module).

Packages

clsql-fluid-bt.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 clsql-fluid-bt

Fluids implemented around Bordeaux-Threads.

Source

fluid.lisp.

Use List

common-lisp.

Public Interface
Internals

5.2 clsql-fluid-system

Source

clsql-fluid.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 Ordinary functions

Reader: fluid-lock (instance)
Writer: (setf fluid-lock) (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Target Slot

lock.

Function: fluid-value (fluid &optional thread)

Answer two values: the value of FLUID for THREAD, and whether a value is present.

Package

clsql-fluid-bt.

Source

fluid.lisp.

Function: (setf fluid-value) (fluid &optional thread)

Alter the value of FLUID for THREAD to NEW-VALUE, answering NEW-VALUE.

Package

clsql-fluid-bt.

Source

fluid.lisp.

Function: make-fluid (&key lock table gc-function gc-count gc-frequency)
Package

clsql-fluid-bt.

Source

fluid.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: copy-fluid (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Function: fluid-gc (fluid)

Clean up FLUID. *Assume it is locked in this thread.*

Package

clsql-fluid-bt.

Source

fluid.lisp.

Reader: fluid-gc-count (instance)
Writer: (setf fluid-gc-count) (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Target Slot

gc-count.

Reader: fluid-gc-frequency (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Target Slot

gc-frequency.

Reader: fluid-gc-function (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Target Slot

gc-function.

Function: fluid-p (object)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Reader: fluid-table (instance)
Package

clsql-fluid-bt.

Source

fluid.lisp.

Target Slot

table.


6.2.2 Structures

Structure: fluid

A container for a different value in each thread. Values are not inherited.

Package

clsql-fluid-bt.

Source

fluid.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: lock
Initform

(bordeaux-threads:make-lock)

Readers

fluid-lock.

Writers

(setf fluid-lock).

Slot: table
Type

hash-table

Initform

(make-hash-table :test (function eql))

Readers

fluid-table.

Writers

This slot is read-only.

Slot: gc-function
Type

(or symbol cons function)

Initform

(function identity)

Readers

fluid-gc-function.

Writers

This slot is read-only.

Slot: gc-count
Type

(and (integer 0) fixnum)

Initform

0

Readers

fluid-gc-count.

Writers

(setf fluid-gc-count).

Slot: gc-frequency
Type

(and (integer 1) fixnum)

Initform

30

Readers

fluid-gc-frequency.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts