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

The clsql-fluid Reference Manual

This is the clsql-fluid Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:42:55 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The clsql-fluid Reference Manual, Up: The clsql-fluid Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The clsql-fluid Reference Manual [Contents][Index]

2 Systems

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

clsql-fluid

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

2.1 `clsql-fluid`

Common Lisp SQL Fluid Connection Pools

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Stephen Compall <scompall@nocandysw.com>

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).

Next: Files, Previous: Systems, Up: The clsql-fluid Reference Manual [Contents][Index]

3 Modules

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

clsql-fluid/sql
clsql-fluid/sql/base

Next: clsql-fluid/sql/base, Previous: Modules, Up: Modules [Contents][Index]

3.1 `clsql-fluid/sql`

Source: clsql-fluid.asd.
Parent Component: clsql-fluid (system).
Child Component: base (module).

Previous: clsql-fluid/sql, Up: Modules [Contents][Index]

3.2 `clsql-fluid/sql/base`

Source: clsql-fluid.asd.
Parent Component: sql (module).
Child Component: fluid.lisp (file).

Next: Packages, Previous: Modules, Up: The clsql-fluid Reference Manual [Contents][Index]

4 Files

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

Lisp

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

4.1 Lisp

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

Next: clsql-fluid/sql/base/fluid.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Previous: clsql-fluid/clsql-fluid.asd, Up: Lisp [Contents][Index]

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

Source

clsql-fluid.asd.

Parent Component

base (module).

Packages

clsql-fluid-bt.

Public Interface

fluid-lock (reader).
(setf fluid-lock) (writer).
fluid-value (function).
(setf fluid-value) (function).
make-fluid (function).

Internals

copy-fluid (function).
fluid (structure).
fluid-gc (function).
fluid-gc-count (reader).
(setf fluid-gc-count) (writer).
fluid-gc-frequency (reader).
fluid-gc-function (reader).
fluid-p (function).
fluid-table (reader).

Next: Definitions, Previous: Files, Up: The clsql-fluid Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

clsql-fluid-bt
clsql-fluid-system

Next: clsql-fluid-system, Previous: Packages, Up: Packages [Contents][Index]

5.1 `clsql-fluid-bt`

Fluids implemented around Bordeaux-Threads.

Source

Use List

common-lisp.

Public Interface

fluid-lock (reader).
(setf fluid-lock) (writer).
fluid-value (function).
(setf fluid-value) (function).
make-fluid (function).

Internals

copy-fluid (function).
fluid (structure).
fluid-gc (function).
fluid-gc-count (reader).
(setf fluid-gc-count) (writer).
fluid-gc-frequency (reader).
fluid-gc-function (reader).
fluid-p (function).
fluid-table (reader).

Previous: clsql-fluid-bt, Up: Packages [Contents][Index]

5.2 `clsql-fluid-system`

Source

clsql-fluid.asd.

Use List

asdf/interface.
common-lisp.

Next: Indexes, Previous: Packages, Up: The clsql-fluid Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

6.2 Internals

Ordinary functions
Structures

Next: Structures, Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.2 Structures

Structure: fluid ¶

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

Package

clsql-fluid-bt.

Source

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.

Previous: Definitions, Up: The clsql-fluid Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( C F M

	Index Entry		Section

(
	`(setf fluid-gc-count)`:		Private ordinary functions
	`(setf fluid-lock)`:		Public ordinary functions
	`(setf fluid-value)`:		Public ordinary functions

C
	`copy-fluid`:		Private ordinary functions

F
	`fluid-gc`:		Private ordinary functions
	`fluid-gc-count`:		Private ordinary functions
	`fluid-gc-frequency`:		Private ordinary functions
	`fluid-gc-function`:		Private ordinary functions
	`fluid-lock`:		Public ordinary functions
	`fluid-p`:		Private ordinary functions
	`fluid-table`:		Private ordinary functions
	`fluid-value`:		Public ordinary functions
	`Function, (setf fluid-gc-count)`:		Private ordinary functions
	`Function, (setf fluid-lock)`:		Public ordinary functions
	`Function, (setf fluid-value)`:		Public ordinary functions
	`Function, copy-fluid`:		Private ordinary functions
	`Function, fluid-gc`:		Private ordinary functions
	`Function, fluid-gc-count`:		Private ordinary functions
	`Function, fluid-gc-frequency`:		Private ordinary functions
	`Function, fluid-gc-function`:		Private ordinary functions
	`Function, fluid-lock`:		Public ordinary functions
	`Function, fluid-p`:		Private ordinary functions
	`Function, fluid-table`:		Private ordinary functions
	`Function, fluid-value`:		Public ordinary functions
	`Function, make-fluid`:		Public ordinary functions

M
	`make-fluid`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	G L S T

	Index Entry		Section

G
	`gc-count`:		Private structures
	`gc-frequency`:		Private structures
	`gc-function`:		Private structures

L
	`lock`:		Private structures

S
	`Slot, gc-count`:		Private structures
	`Slot, gc-frequency`:		Private structures
	`Slot, gc-function`:		Private structures
	`Slot, lock`:		Private structures
	`Slot, table`:		Private structures

T
	`table`:		Private structures

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

A.4 Data types

Jump to:	B C F M P S

	Index Entry		Section

B
	`base`:		The clsql-fluid/sql/base module

C
	`clsql-fluid`:		The clsql-fluid system
	`clsql-fluid-bt`:		The clsql-fluid-bt package
	`clsql-fluid-system`:		The clsql-fluid-system package
	`clsql-fluid.asd`:		The clsql-fluid/clsql-fluid․asd file

F
	`File, clsql-fluid.asd`:		The clsql-fluid/clsql-fluid․asd file
	`File, fluid.lisp`:		The clsql-fluid/sql/base/fluid․lisp file
	`fluid`:		Private structures
	`fluid.lisp`:		The clsql-fluid/sql/base/fluid․lisp file

M
	`Module, base`:		The clsql-fluid/sql/base module
	`Module, sql`:		The clsql-fluid/sql module

P
	`Package, clsql-fluid-bt`:		The clsql-fluid-bt package
	`Package, clsql-fluid-system`:		The clsql-fluid-system package

S
	`sql`:		The clsql-fluid/sql module
	`Structure, fluid`:		Private structures
	`System, clsql-fluid`:		The clsql-fluid system