The cl-prevalence Reference Manual

Child Component

src (module).

3 Modules

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

cl-prevalence/src
cl-prevalence/src/serialization

3.1 `cl-prevalence/src`

Source

Parent Component

cl-prevalence (system).

Child Components

package.lisp (file).
serialization (module).
prevalence.lisp (file).
managed-prevalence.lisp (file).
master-slave.lisp (file).
blob.lisp (file).

3.2 `cl-prevalence/src/serialization`

Dependency

package.lisp (file).

Source

Parent Component

src (module).

Child Components

serialization.lisp (file).
xml.lisp (file).
sexp.lisp (file).

4 Files

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

Lisp

4.1 Lisp

cl-prevalence/cl-prevalence.asd
cl-prevalence/src/package.lisp
cl-prevalence/src/serialization/serialization.lisp
cl-prevalence/src/serialization/xml.lisp
cl-prevalence/src/serialization/sexp.lisp
cl-prevalence/src/prevalence.lisp
cl-prevalence/src/managed-prevalence.lisp
cl-prevalence/src/master-slave.lisp
cl-prevalence/src/blob.lisp

4.1.1 `cl-prevalence/cl-prevalence.asd`

Source: cl-prevalence.asd.
Parent Component: cl-prevalence (system).
ASDF Systems: cl-prevalence.

4.1.2 `cl-prevalence/src/package.lisp`

Source

Parent Component

src (module).

Packages

s-serialization.
cl-prevalence.

4.1.3 `cl-prevalence/src/serialization/serialization.lisp`

Source

Parent Component

serialization (module).

Public Interface

make-serialization-state (function).
reset-known-slots (generic function).
serializable-slots (generic function).

Internals

+cl-package+ (constant).
+keyword-package+ (constant).
get-counter (reader method).
(setf get-counter) (writer method).
get-hashtable (reader method).
get-serializable-slots (method).
get-xml-parser-state (method).
known-object-id (method).
reset (method).
sequence-type-and-length (function).
serialization-state (class).
set-known-object (method).

4.1.4 `cl-prevalence/src/serialization/xml.lisp`

Dependency

serialization.lisp (file).

Source

Parent Component

serialization (module).

Public Interface

deserialize-xml (function).
serialize-xml (function).

Internals

deserialize-xml-finish-element (function).
deserialize-xml-finish-element-aux (generic function).
deserialize-xml-new-element (function).
deserialize-xml-new-element-aux (generic function).
deserialize-xml-text (function).
get-attribute-value (function).
print-symbol-xml (function).
serialize-sexp-internal (method).
serialize-xml-internal (generic function).

4.1.5 `cl-prevalence/src/serialization/sexp.lisp`

Dependency

serialization.lisp (file).

Source

Parent Component

serialization (module).

Public Interface

deserialize-sexp (function).
serialize-sexp (function).

Internals

deserialize-class (generic function).
deserialize-sexp-internal (function).
deserialize-struct (generic function).
print-symbol (function).
serialize-sexp-internal (generic function).

4.1.6 `cl-prevalence/src/prevalence.lisp`

Dependency

serialization (module).

Source

Parent Component

src (module).

Public Interface

backup (generic function).
close-open-streams (method).
execute (generic function).
get-guard (reader method).
(setf get-guard) (writer method).
get-option (generic function).
(setf get-option) (generic function).
get-root-object (generic function).
(setf get-root-object) (generic function).
get-transaction-hook (reader method).
(setf get-transaction-hook) (writer method).
guarded-prevalence-system (class).
initialize-instance (method).
initiates-rollback (generic function).
make-prevalence-system (function).
make-transaction (function).
no-rollback-error (condition).
prevalence-system (class).
print-object (method).
query (generic function).
remove-root-object (generic function).
reset-known-slots (method).
restore (generic function).
snapshot (generic function).
totally-destroy (generic function).
transaction (class).

Internals

copy-file (function).
execute-on (generic function).
get-args (reader method).
(setf get-args) (writer method).
get-deserializer (reader method).
(setf get-deserializer) (writer method).
get-directory (reader method).
(setf get-directory) (writer method).
get-file-extension (reader method).
(setf get-file-extension) (writer method).
get-function (reader method).
(setf get-function) (writer method).
get-root-objects (reader method).
(setf get-root-objects) (writer method).
get-serialization-state (reader method).
get-serializer (reader method).
(setf get-serializer) (writer method).
get-snapshot (reader method).
(setf get-snapshot) (writer method).
get-snapshot-filename (method).
get-transaction-log (reader method).
(setf get-transaction-log) (writer method).
get-transaction-log-filename (method).
get-transaction-log-stream (reader method).
get-transaction-log-stream (method).
(setf get-transaction-log-stream) (writer method).
log-transaction (method).
log-transaction (method).
timetag (function).
truncate-file (function).

4.1.7 `cl-prevalence/src/managed-prevalence.lisp`

Dependency

prevalence.lisp (file).

Source

Parent Component

src (module).

Public Interface

all-preferences-keys (generic function).
drop-index-on (function).
execute-transaction (macro).
find-all-objects (generic function).
find-object-with-id (generic function).
find-object-with-slot (generic function).
get-id (generic reader).
get-preference (generic function).
index-on (function).
next-id (method).
object-with-id (class).
tx-change-object-slots (function).
tx-create-id-counter (function).
tx-create-object (function).
tx-delete-object (function).
tx-set-preference (function).

Internals

add-object-to-slot-index (function).
get-objects-root-name (function).
get-objects-slot-index-name (function).
remove-object-from-slot-index (function).
slot-value-changed-p (function).
tx-create-objects-slot-index (function).
tx-remove-objects-slot-index (function).

4.1.8 `cl-prevalence/src/master-slave.lisp`

Dependency

prevalence.lisp (file).

Source

Parent Component

src (module).

Public Interface

start-master-client (function).
start-slave-server (function).
stop-master-client (function).
stop-slave-server (function).

4.1.9 `cl-prevalence/src/blob.lisp`

Dependency

managed-prevalence.lisp (file).

Source

Parent Component

src (module).

Public Interface

*blob-root* (special variable).
blob (class).
copy-to-stream (generic function).
destroy (generic function).
fill-from-file (generic function).
fill-from-stream (generic function).
get-file (generic function).
get-keywords (generic reader).
(setf get-keywords) (generic writer).
get-mime-type (generic reader).
(setf get-mime-type) (generic writer).
get-name (generic reader).
(setf get-name) (generic writer).
get-size (generic function).
print-object (method).

Internals

copy-stream (function).
set-size-from-file (method).
size-from-file (method).

5 Packages

Packages are listed by definition order.

s-serialization
cl-prevalence

5.1 `s-serialization`

XML and s-expression based serialization for Common Lisp and CLOS

Source

package.lisp.

Use List

common-lisp.

Used By List

Public Interface

deserialize-sexp (function).
deserialize-xml (function).
make-serialization-state (function).
reset-known-slots (generic function).
serializable-slots (generic function).
serialize-sexp (function).
serialize-xml (function).

Internals

+cl-package+ (constant).
+keyword-package+ (constant).
deserialize-class (generic function).
deserialize-sexp-internal (function).
deserialize-struct (generic function).
deserialize-xml-finish-element (function).
deserialize-xml-finish-element-aux (generic function).
deserialize-xml-new-element (function).
deserialize-xml-new-element-aux (generic function).
deserialize-xml-text (function).
get-attribute-value (function).
get-counter (generic reader).
(setf get-counter) (generic writer).
get-hashtable (generic reader).
get-serializable-slots (generic function).
get-xml-parser-state (generic function).
known-object-id (generic function).
print-symbol (function).
print-symbol-xml (function).
reset (generic function).
sequence-type-and-length (function).
serialization-state (class).
serialize-sexp-internal (generic function).
serialize-xml-internal (generic function).
set-known-object (generic function).

5.2 `cl-prevalence`

An implementation of Object Prevalence for Common Lisp

Source

package.lisp.

Use List

common-lisp.
s-serialization.

Public Interface

*blob-root* (special variable).
all-preferences-keys (generic function).
backup (generic function).
blob (class).
close-open-streams (generic function).
copy-to-stream (generic function).
destroy (generic function).
drop-index-on (function).
execute (generic function).
execute-transaction (macro).
fill-from-file (generic function).
fill-from-stream (generic function).
find-all-objects (generic function).
find-object-with-id (generic function).
find-object-with-slot (generic function).
get-file (generic function).
get-guard (generic reader).
(setf get-guard) (generic writer).
get-id (generic reader).
get-keywords (generic reader).
(setf get-keywords) (generic writer).
get-mime-type (generic reader).
(setf get-mime-type) (generic writer).
get-name (generic reader).
(setf get-name) (generic writer).
get-option (generic function).
(setf get-option) (generic function).
get-preference (generic function).
get-root-object (generic function).
(setf get-root-object) (generic function).
get-size (generic function).
get-transaction-hook (generic reader).
(setf get-transaction-hook) (generic writer).
guarded-prevalence-system (class).
index-on (function).
initiates-rollback (generic function).
make-prevalence-system (function).
make-transaction (function).
next-id (generic function).
no-rollback-error (condition).
object-with-id (class).
prevalence-system (class).
query (generic function).
remove-root-object (generic function).
restore (generic function).
snapshot (generic function).
start-master-client (function).
start-slave-server (function).
stop-master-client (function).
stop-slave-server (function).
totally-destroy (generic function).
transaction (class).
tx-change-object-slots (function).
tx-create-id-counter (function).
tx-create-object (function).
tx-delete-object (function).
tx-set-preference (function).

Internals

add-object-to-slot-index (function).
copy-file (function).
copy-stream (function).
execute-on (generic function).
get-args (generic reader).
(setf get-args) (generic writer).
get-deserializer (generic reader).
(setf get-deserializer) (generic writer).
get-directory (generic reader).
(setf get-directory) (generic writer).
get-file-extension (generic reader).
(setf get-file-extension) (generic writer).
get-function (generic reader).
(setf get-function) (generic writer).
get-objects-root-name (function).
get-objects-slot-index-name (function).
get-root-objects (generic reader).
(setf get-root-objects) (generic writer).
get-serialization-state (generic reader).
get-serializer (generic reader).
(setf get-serializer) (generic writer).
get-snapshot (generic reader).
(setf get-snapshot) (generic writer).
get-snapshot-filename (generic function).
get-transaction-log (generic reader).
(setf get-transaction-log) (generic writer).
get-transaction-log-filename (generic function).
get-transaction-log-stream (generic function).
(setf get-transaction-log-stream) (generic writer).
log-transaction (generic function).
remove-object-from-slot-index (function).
set-size-from-file (generic function).
size-from-file (generic function).
slot-value-changed-p (function).
timetag (function).
truncate-file (function).
tx-create-objects-slot-index (function).
tx-remove-objects-slot-index (function).

6 Definitions

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

Public Interface
Internals

6.1.1 Special variables

Special Variable: *blob-root* ¶

The directory in which to store the blob files

Package: cl-prevalence.
Source: blob.lisp.

6.1.2 Macros

Macro: execute-transaction (transaction-call) ¶

Create a transaction object from transaction-call and execute it

Package: cl-prevalence.
Source: managed-prevalence.lisp.

6.1.3 Ordinary functions

Function: deserialize-sexp (stream &optional serialization-state) ¶

Read and return an s-expression serialized version of a lisp object from stream, optionally reusing a serialization state

Package: s-serialization.
Source: sexp.lisp.

Function: deserialize-xml (stream &optional serialization-state) ¶

Read and return an XML serialized version of a lisp object from stream, optionally reusing a serialization state

Package: s-serialization.
Source: xml.lisp.

Function: drop-index-on (system class &optional slots) ¶

Drop indexes on each of the slots provided

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: index-on (system class &optional slots test) ¶

Create indexes on each of the slots provided.

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: make-prevalence-system (directory &key prevalence-system-class init-args) ¶

Create and return a new prevalence system on directory. When the directory contains a valid snapshot and/or transaction log file, the system will be restored. Optionally specify the prevalence system’s class.

Package: cl-prevalence.
Source: prevalence.lisp.

Function: make-serialization-state () ¶

Create a reusable serialization state to pass as optional argument to [de]serialize-xml

Package: s-serialization.
Source: serialization.lisp.

Function: make-transaction (function &rest args) ¶

Create and return a new transaction specifying a function name and an argument list. The function should accept the system instance prepended to the argument list as arguments and implement the actual transaction in a re-entrant way.

Package: cl-prevalence.
Source: prevalence.lisp.

Function: serialize-sexp (object stream &optional serialization-state) ¶

Write a serialized version of object to stream using s-expressions, optionally reusing a serialization-state

Package: s-serialization.
Source: sexp.lisp.

Function: serialize-xml (object stream &optional serialization-state) ¶

Write a serialized version of object to stream using XML, optionally reusing a serialization-state

Package: s-serialization.
Source: xml.lisp.

Function: start-master-client (prevalence-system &key host port) ¶

Start a connection to host:port to deliver transactions from prevalence-system

Package: cl-prevalence.
Source: master-slave.lisp.

Function: start-slave-server (prevalence-system &key port) ¶

Start a server on port accepting transactions to be executed on prevalence-system Returns a thread object

Package: cl-prevalence.
Source: master-slave.lisp.

Function: stop-master-client (prevalence-sytem) ¶

Stop a connection from prevalence-system

Package: cl-prevalence.
Source: master-slave.lisp.

Function: stop-slave-server (server-thread) ¶

Package: cl-prevalence.
Source: master-slave.lisp.

Function: tx-change-object-slots (system class id slots-and-values) ¶

Change some slots of the object of class with id in system using slots and values

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: tx-create-id-counter (system) ¶

Initialize the id counter to 0

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: tx-create-object (system class &optional slots-and-values) ¶

Create a new object of class in system, assigning it a unique id, optionally setting some slots and values

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: tx-delete-object (system class id) ¶

Delete the object of class with id from the system

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: tx-set-preference (system key value) ¶

Set the value of the persistent preference key in system

Package: cl-prevalence.
Source: managed-prevalence.lisp.

6.1.4 Generic functions

Generic Function: all-preferences-keys (system) ¶

Return a list of all persistent preference keys of system

Package

Source

Methods

Method: all-preferences-keys ((system prevalence-system)) ¶: Return a list of all persistent preference keys of system

Generic Function: backup (system &key directory) ¶

Make backup copies of the current snapshot and transaction-log files

Package

Source

Methods

Method: backup ((system guarded-prevalence-system) &key directory) ¶: Do a backup on a system controlled by a guard

Method: backup ((system prevalence-system) &key directory) ¶: Make backup copies of the current snapshot and transaction-log files

Generic Function: close-open-streams (system &key abort) ¶

Package

Methods

Method: close-open-streams ((system prevalence-system) &key abort) ¶

Close all open stream associated with system (optionally aborting operations in progress)

Source: prevalence.lisp.

Generic Function: copy-to-stream (blob binary-output-stream) ¶

Copy the bytes from blob to binary-output-stream

Package

Source

Methods

Method: copy-to-stream ((blob blob) binary-output-stream) ¶: Copy the bytes from blob to binary-output-stream

Generic Function: destroy (blob) ¶

Completely destroy blob (removing its byte data file as well)

Package

Source

Methods

Method: destroy ((blob blob)) ¶

Generic Function: execute (system object) ¶

Ask for a transaction object to be executed on system with ACID properties

Package

Source

Methods

Method: execute ((system guarded-prevalence-system) (transaction transaction)) ¶: Execute a transaction on a system controlled by a guard

Method: execute ((system prevalence-system) (transaction transaction)) ¶: Execute a transaction on a system and log it to the transaction log

Generic Function: fill-from-file (blob pathname) ¶

Fill the blob’s contents with the bytes read from the binary file at pathname

Package

Source

Methods

Method: fill-from-file ((blob blob) pathname) ¶: Fill the blob’s contents with the bytes read from the binary file at pathname

Generic Function: fill-from-stream (blob binary-input-stream) ¶

Fill the blob’s contents with the bytes from binary-input-stream

Package

Source

Methods

Method: fill-from-stream ((blob blob) binary-input-stream) ¶: Fill the blob’s contents with the bytes from binary-input-stream

Generic Function: find-all-objects (system class) ¶

Return an unordered collection of all objects in system that are instances of class

Package

Source

Methods

Method: find-all-objects ((system prevalence-system) class) ¶: Return an unordered collection of all objects in system that are instances of class

Generic Function: find-object-with-id (system class id) ¶

Find and return the object in system of class with id, null if not found

Package

Source

Methods

Method: find-object-with-id ((system prevalence-system) class id) ¶: Find and return the object in system of class with id, null if not found

Generic Function: find-object-with-slot (system class slot value &optional test) ¶

Find and return the object in system of class with slot equal to value, null if not found

Package

Source

Methods

Method: find-object-with-slot ((system prevalence-system) class slot value &optional test) ¶: Find and return the object in system of class with slot equal to value, null if not found

Generic Function: get-file (blob) ¶

Return the pathname to the bytes of blob

Package

Source

Methods

Method: get-file ((blob blob)) ¶

Generic Reader: get-guard (object) ¶

Access the guard function of a sytem

Package

Methods

Reader Method: get-guard ((guarded-prevalence-system guarded-prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: guard.

Generic Writer: (setf get-guard) (object) ¶

Set the guard function of a system

Package

Methods

Writer Method: (setf get-guard) ((guarded-prevalence-system guarded-prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: guard.

Generic Reader: get-id (object) ¶

Return an external, unique, immutable identifier for object (typically an integer)

Package

Source

Methods

Reader Method: get-id ((object-with-id object-with-id)) ¶

automatically generated reader method

Target Slot: id.

Generic Reader: get-keywords (blob) ¶

Return the list of keywords associated with blob

Package

Source

Methods

Reader Method: get-keywords ((blob blob)) ¶

automatically generated reader method

Target Slot: keywords.

Generic Writer: (setf get-keywords) (blob) ¶

Set the keywords list of blob

Package

Source

Methods

Writer Method: (setf get-keywords) ((blob blob)) ¶

automatically generated writer method

Target Slot: keywords.

Generic Reader: get-mime-type (blob) ¶

Return the mime-type of blob as a string

Package

Source

Methods

Reader Method: get-mime-type ((blob blob)) ¶

automatically generated reader method

Target Slot: mime-type.

Generic Writer: (setf get-mime-type) (blob) ¶

Set the mime-type string of blob

Package

Source

Methods

Writer Method: (setf get-mime-type) ((blob blob)) ¶

automatically generated writer method

Target Slot: mime-type.

Generic Reader: get-name (blob) ¶

Return the descriptive name of blob

Package

Source

Methods

Reader Method: get-name ((blob blob)) ¶

automatically generated reader method

Target Slot: name.

Generic Writer: (setf get-name) (blob) ¶

Set the descriptive name of blob

Package

Source

Methods

Writer Method: (setf get-name) ((blob blob)) ¶

automatically generated writer method

Target Slot: name.

Generic Function: get-option (system name) ¶

Retrieve a named option from system

Package

Source

Methods

Method: get-option ((system prevalence-system) name) ¶

Generic Function: (setf get-option) (system name) ¶

Set a named option of system to value

Package

Source

Methods

Method: (setf get-option) ((system prevalence-system) name) ¶

Generic Function: get-preference (system key) ¶

Retrieve the value of the persistent preference stored under key in system

Package

Source

Methods

Method: get-preference ((system prevalence-system) key) ¶: Retrieve the value of the persistent preference stored under key in system

Generic Function: get-root-object (system name) ¶

Retrieve a root object by symbol name from system

Package

Source

Methods

Method: get-root-object ((system prevalence-system) name) ¶

Generic Function: (setf get-root-object) (system name) ¶

Set a symbol named root object of system to value

Package

Source

Methods

Method: (setf get-root-object) ((system prevalence-system) name) ¶

Generic Function: get-size (blob) ¶

Return the size of blob in bytes

Package

Source

Methods

Reader Method: get-size :before ((blob blob)) ¶

Target Slot: size.

Method: get-size ((blob blob)) ¶: automatically generated reader method

Generic Reader: get-transaction-hook (object) ¶

Package

Methods

Reader Method: get-transaction-hook ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: transaction-hook.

Generic Writer: (setf get-transaction-hook) (object) ¶

Package

Methods

Writer Method: (setf get-transaction-hook) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: transaction-hook.

Generic Function: initiates-rollback (condition) ¶

Return true when a condition initiates a rollback when thrown from a transaction

Package

Source

Methods

Method: initiates-rollback ((no-rollback-error no-rollback-error)) ¶

Method: initiates-rollback ((condition condition)) ¶

Generic Function: next-id (system) ¶

Package

Methods

Method: next-id ((system prevalence-system)) ¶

Increment and return the next id

Source: managed-prevalence.lisp.

Generic Function: query (system function &rest args) ¶

Ask for a query function to be executed on system with args

Package

Source

Methods

Method: query ((system guarded-prevalence-system) function &rest args) ¶: Execute an exclusive query function on a sytem controlled by a guard

Method: query ((system prevalence-system) function &rest args) ¶: Execute an exclusive query function on a sytem

Generic Function: remove-root-object (system name) ¶

Remove the root object by symbol name from system

Package

Source

Methods

Method: remove-root-object ((system prevalence-system) name) ¶

Generic Function: reset-known-slots (serialization-state &optional class) ¶

Clear the caching of known slots for class, or for all classes if class is nil

Package

Source

serialization.lisp.

Methods

Method: reset-known-slots ((system prevalence-system) &optional class) ¶

Source: prevalence.lisp.

Method: reset-known-slots ((serialization-state serialization-state) &optional class) ¶

Generic Function: restore (system) ¶

Restore a system from permanent storage

Package

Source

Methods

Method: restore ((system guarded-prevalence-system)) ¶: Restore a system controlled by a guard

Method: restore ((system prevalence-system)) ¶: Load a system from persistent storage starting from the last snapshot and replaying the transaction log

Generic Function: serializable-slots (object) ¶

Return a list of slot names that need serialization

Package

Source

serialization.lisp.

Methods

Method: serializable-slots ((object standard-object)) ¶

Method: serializable-slots ((object structure-object)) ¶

Generic Function: snapshot (system) ¶

Take a snapshot of a system

Package

Source

Methods

Method: snapshot ((system guarded-prevalence-system)) ¶: Make a snapshot of a system controlled by a guard

Method: snapshot ((system prevalence-system)) ¶: Write to whole system to persistent storage resetting the transaction log

Generic Function: totally-destroy (system &key abort) ¶

Totally destroy system from permanent storage by deleting any files that we find

Package

Source

Methods

Method: totally-destroy ((system prevalence-system) &key abort) ¶: Totally destroy system from permanent storage by deleting any files used by the system, remove all root objects

6.1.5 Standalone methods

Method: initialize-instance :after ((system prevalence-system) &rest initargs &key &allow-other-keys) ¶

After a system is initialized, derive its file paths and try to restore it

Source: prevalence.lisp.

Method: print-object ((blob blob) stream) ¶

Source: blob.lisp.

Method: print-object ((transaction transaction) stream) ¶

Source: prevalence.lisp.

6.1.6 Conditions

Condition: no-rollback-error ¶

Thrown by code inside a transaction to indicate that no rollback is needed

Package: cl-prevalence.
Source: prevalence.lisp.
Direct superclasses: error.
Direct methods: initiates-rollback.

6.1.7 Classes

Class: blob ¶

A blob is a file-like collection of bytes with related metadata

Package

Source

Direct superclasses

object-with-id.

Direct methods

copy-to-stream.
destroy.
fill-from-file.
fill-from-stream.
get-file.
(setf get-keywords).
get-keywords.
(setf get-mime-type).
get-mime-type.
(setf get-name).
get-name.
get-size.
get-size.
print-object.
set-size-from-file.
size-from-file.

Direct slots

Slot: name ¶

Initform: "untitled"
Initargs: :name
Readers: get-name.
Writers: (setf get-name).

Slot: size ¶

Initform: -1
Initargs: :size
Readers: get-size.
Writers: This slot is read-only.

Slot: mime-type ¶

Initform: "application/octet-stream"
Initargs: :mime-type
Readers: get-mime-type.
Writers: (setf get-mime-type).

Slot: keywords ¶

Initform: (quote nil)
Initargs: :keywords
Readers: get-keywords.
Writers: (setf get-keywords).

Class: guarded-prevalence-system ¶

A Prevalence system with a guard thunk

Package

Source

Direct superclasses

prevalence-system.

Direct methods

backup.
execute.
(setf get-guard).
get-guard.
query.
restore.
snapshot.

Direct slots

Slot: guard ¶

Initform: (function (lambda (cl-prevalence::thunk) (funcall cl-prevalence::thunk)))
Readers: get-guard.
Writers: (setf get-guard).

Class: object-with-id ¶

Superclass for objects with an id

Package

Source

Direct subclasses

blob.

Direct methods

get-id.

Direct slots

Slot: id ¶

Initform: -1
Initargs: :id
Readers: get-id.
Writers: This slot is read-only.

Class: prevalence-system ¶

Base Prevalence system implementation object

Package

Source

guarded-prevalence-system.

Direct subclasses

Direct methods

all-preferences-keys.
backup.
close-open-streams.
execute.
execute-on.
find-all-objects.
find-object-with-id.
find-object-with-slot.
(setf get-deserializer).
get-deserializer.
(setf get-directory).
get-directory.
(setf get-file-extension).
get-file-extension.
(setf get-option).
get-option.
get-preference.
(setf get-root-object).
get-root-object.
(setf get-root-objects).
get-root-objects.
get-serialization-state.
(setf get-serializer).
get-serializer.
(setf get-snapshot).
get-snapshot.
get-snapshot-filename.
(setf get-transaction-hook).
get-transaction-hook.
(setf get-transaction-log).
get-transaction-log.
get-transaction-log-filename.
get-transaction-log-stream.
(setf get-transaction-log-stream).
get-transaction-log-stream.
initialize-instance.
log-transaction.
log-transaction.
next-id.
query.
remove-root-object.
reset-known-slots.
restore.
snapshot.
totally-destroy.

Direct slots

Slot: directory ¶

Package: common-lisp.
Initargs: :directory
Readers: get-directory.
Writers: (setf get-directory).

Slot: root-objects ¶

Initform: (make-hash-table :test (quote eq))
Readers: get-root-objects.
Writers: (setf get-root-objects).

Slot: options ¶

Initform: (make-hash-table :test (quote eq))

Slot: snapshot ¶

Readers: get-snapshot.
Writers: (setf get-snapshot).

Slot: transaction-log ¶

Readers: get-transaction-log.
Writers: (setf get-transaction-log).

Slot: transaction-log-stream ¶

Readers: get-transaction-log-stream.
Writers: (setf get-transaction-log-stream).

Slot: serializer ¶

Initform: (function s-serialization:serialize-xml)
Initargs: :serializer
Readers: get-serializer.
Writers: (setf get-serializer).

Slot: deserializer ¶

Initform: (function s-serialization:deserialize-xml)
Initargs: :deserializer
Readers: get-deserializer.
Writers: (setf get-deserializer).

Slot: file-extension ¶

Initform: "xml"
Initargs: :file-extension
Readers: get-file-extension.
Writers: (setf get-file-extension).

Slot: serialization-state ¶

Initform: (s-serialization:make-serialization-state)
Readers: get-serialization-state.
Writers: This slot is read-only.

Slot: transaction-hook ¶

Initform: (function identity)
Initargs: :transaction-hook
Readers: get-transaction-hook.
Writers: (setf get-transaction-hook).

Class: transaction ¶

A simple Transaction object joining a function and its arguments

Package

Source

Direct methods

execute.
execute.
execute-on.
(setf get-args).
get-args.
(setf get-function).
get-function.
log-transaction.
log-transaction.
print-object.

Direct slots

Slot: args ¶

Initargs: :args
Readers: get-args.
Writers: (setf get-args).

Slot: function ¶

Package: common-lisp.
Initform: (quote identity)
Initargs: :function
Readers: get-function.
Writers: (setf get-function).

6.2 Internals

Constants
Ordinary functions
Generic functions
Classes

6.2.1 Constants

Constant: +cl-package+ ¶

Package: s-serialization.
Source: serialization.lisp.

Constant: +keyword-package+ ¶

Package: s-serialization.
Source: serialization.lisp.

6.2.2 Ordinary functions

Function: add-object-to-slot-index (system class slot object) ¶

Add an index entry using this slot to this object

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: copy-file (source target) ¶

Package: cl-prevalence.
Source: prevalence.lisp.

Function: copy-stream (in out &optional element-type) ¶

Copy everything from in to out

Package: cl-prevalence.
Source: blob.lisp.

Function: deserialize-sexp-internal (sexp deserialized-objects) ¶

Package: s-serialization.
Source: sexp.lisp.

Function: deserialize-xml-finish-element (name attributes parent-seed seed) ¶

Package: s-serialization.
Source: xml.lisp.

Function: deserialize-xml-new-element (name attributes seed) ¶

Package: s-serialization.
Source: xml.lisp.

Function: deserialize-xml-text (string seed) ¶

Package: s-serialization.
Source: xml.lisp.

Function: get-attribute-value (name attributes) ¶

Package: s-serialization.
Source: xml.lisp.

Function: get-objects-root-name (class) ¶

Return the keyword symbol naming the root of instances of class

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: get-objects-slot-index-name (class &optional slot) ¶

Return the keyword symbol naming the specified index of instances of class.

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: print-symbol (symbol stream) ¶

Package: s-serialization.
Source: sexp.lisp.

Function: print-symbol-xml (symbol stream) ¶

Package: s-serialization.
Source: xml.lisp.

Function: remove-object-from-slot-index (system class slot object) ¶

Remove the index entry using this slot to this object

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: sequence-type-and-length (sequence) ¶

Package: s-serialization.
Source: serialization.lisp.

Function: slot-value-changed-p (object slot value) ¶

Return true when slot in object is not eql to value (or when the slot was unbound)

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: timetag (&optional universal-time) ¶

Return a GMT string of universal-time as YYMMDDTHHMMSS

Package: cl-prevalence.
Source: prevalence.lisp.

Function: truncate-file (file position) ¶

Truncate the physical file at position by copying and replacing it

Package: cl-prevalence.
Source: prevalence.lisp.

Function: tx-create-objects-slot-index (system class slot &optional test) ¶

Create an index for this object on this slot, with an optional test for the hash table (add existing objects)

Package: cl-prevalence.
Source: managed-prevalence.lisp.

Function: tx-remove-objects-slot-index (system class slot) ¶

Remove an index for this object on this slot

Package: cl-prevalence.
Source: managed-prevalence.lisp.

6.2.3 Generic functions

Generic Function: deserialize-class (class-symbol slots serialization-state) ¶

Read and return an s-expression serialized version of a Lisp class from stream.

Package

Source

sexp.lisp.

Methods

Method: deserialize-class (class-symbol slots deserialized-objects) ¶

Generic Function: deserialize-struct (struct-symbol slots serialization-state) ¶

Read and return an s-expression serialized version of a Lisp struct from stream.

Package

Source

sexp.lisp.

Methods

Method: deserialize-struct (struct-symbol slots deserialized-objects) ¶

Generic Function: deserialize-xml-finish-element-aux (name attributes parent-seed seed) ¶

Extend with your own types by overloading serialize-xml-internal and implementing deserialize aux functions

Package

Source

xml.lisp.

Methods

Method: deserialize-xml-finish-element-aux (name attributes parent-seed seed) ¶

Generic Function: deserialize-xml-new-element-aux (name attributes) ¶

Extend with your own types by overloading serialize-xml-internal and implementing deserialize aux functions

Package

Source

xml.lisp.

Methods

Method: deserialize-xml-new-element-aux (name attributes) ¶

Generic Function: execute-on (object system) ¶

Ask for a transaction object to execute its changes in the context of system

Package

Source

Methods

Method: execute-on ((transaction transaction) (system prevalence-system)) ¶: Execute a transaction itself in the context of a system

Generic Reader: get-args (object) ¶

Package

Methods

Reader Method: get-args ((transaction transaction)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: args.

Generic Writer: (setf get-args) (object) ¶

Package

Methods

Writer Method: (setf get-args) ((transaction transaction)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: args.

Generic Reader: get-counter (object) ¶

Package

Methods

Reader Method: get-counter ((serialization-state serialization-state)) ¶

automatically generated reader method

Source: serialization.lisp.
Target Slot: counter.

Generic Writer: (setf get-counter) (object) ¶

Package

Methods

Writer Method: (setf get-counter) ((serialization-state serialization-state)) ¶

automatically generated writer method

Source: serialization.lisp.
Target Slot: counter.

Generic Reader: get-deserializer (object) ¶

Package

Methods

Reader Method: get-deserializer ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: deserializer.

Generic Writer: (setf get-deserializer) (object) ¶

Package

Methods

Writer Method: (setf get-deserializer) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: deserializer.

Generic Reader: get-directory (object) ¶

Package

Methods

Reader Method: get-directory ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: directory.

Generic Writer: (setf get-directory) (object) ¶

Package

Methods

Writer Method: (setf get-directory) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: directory.

Generic Reader: get-file-extension (object) ¶

Package

Methods

Reader Method: get-file-extension ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: file-extension.

Generic Writer: (setf get-file-extension) (object) ¶

Package

Methods

Writer Method: (setf get-file-extension) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: file-extension.

Generic Reader: get-function (object) ¶

Package

Methods

Reader Method: get-function ((transaction transaction)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: function.

Generic Writer: (setf get-function) (object) ¶

Package

Methods

Writer Method: (setf get-function) ((transaction transaction)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: function.

Generic Reader: get-hashtable (object) ¶

Package

Methods

Reader Method: get-hashtable ((serialization-state serialization-state)) ¶

automatically generated reader method

Source: serialization.lisp.
Target Slot: hashtable.

Generic Reader: get-root-objects (object) ¶

Package

Methods

Reader Method: get-root-objects ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: root-objects.

Generic Writer: (setf get-root-objects) (object) ¶

Package

Methods

Writer Method: (setf get-root-objects) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: root-objects.

Generic Function: get-serializable-slots (serialization-state object) ¶

Package

Methods

Method: get-serializable-slots ((serialization-state serialization-state) object) ¶

Source: serialization.lisp.

Generic Reader: get-serialization-state (object) ¶

Package

Methods

Reader Method: get-serialization-state ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: serialization-state.

Generic Reader: get-serializer (object) ¶

Package

Methods

Reader Method: get-serializer ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: serializer.

Generic Writer: (setf get-serializer) (object) ¶

Package

Methods

Writer Method: (setf get-serializer) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: serializer.

Generic Reader: get-snapshot (object) ¶

Package

Methods

Reader Method: get-snapshot ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: snapshot.

Generic Writer: (setf get-snapshot) (object) ¶

Package

Methods

Writer Method: (setf get-snapshot) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: snapshot.

Generic Function: get-snapshot-filename (system &optional suffix) ¶

Package

Methods

Method: get-snapshot-filename ((system prevalence-system) &optional suffix) ¶

Return the name of the snapshot filename, optionally using a suffix

Source: prevalence.lisp.

Generic Reader: get-transaction-log (object) ¶

Package

Methods

Reader Method: get-transaction-log ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.
Target Slot: transaction-log.

Generic Writer: (setf get-transaction-log) (object) ¶

Package

Methods

Writer Method: (setf get-transaction-log) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: transaction-log.

Generic Function: get-transaction-log-filename (system &optional suffix) ¶

Package

Methods

Method: get-transaction-log-filename ((system prevalence-system) &optional suffix) ¶

Return the name of the transaction-log filename, optionally using a suffix

Source: prevalence.lisp.

Generic Function: get-transaction-log-stream (object) ¶

Package

Methods

Reader Method: get-transaction-log-stream :before ((system prevalence-system)) ¶

Source: prevalence.lisp.
Target Slot: transaction-log-stream.

Method: get-transaction-log-stream ((prevalence-system prevalence-system)) ¶

automatically generated reader method

Source: prevalence.lisp.

Generic Writer: (setf get-transaction-log-stream) (object) ¶

Package

Methods

Writer Method: (setf get-transaction-log-stream) ((prevalence-system prevalence-system)) ¶

automatically generated writer method

Source: prevalence.lisp.
Target Slot: transaction-log-stream.

Generic Function: get-xml-parser-state (serialization-state) ¶

Package

Methods

Method: get-xml-parser-state ((serialization-state serialization-state)) ¶

Source: serialization.lisp.

Generic Function: known-object-id (serialization-state object) ¶

Package

Methods

Method: known-object-id ((serialization-state serialization-state) object) ¶

Source: serialization.lisp.

Generic Function: log-transaction (system transaction) ¶

Package

Methods

Method: log-transaction :after ((system prevalence-system) (transaction transaction)) ¶

Execute the transaction-hook

Source: prevalence.lisp.

Method: log-transaction ((system prevalence-system) (transaction transaction)) ¶

Log transaction for system

Source: prevalence.lisp.

Generic Function: reset (serialization-state) ¶

Package

Methods

Method: reset ((serialization-state serialization-state)) ¶

Source: serialization.lisp.

Generic Function: serialize-sexp-internal (object stream serialization-state) ¶

Write a serialized version of object to stream using s-expressions

Package

Source

sexp.lisp.

Methods

Method: serialize-sexp-internal ((object standard-object) stream serialization-state) ¶

Method: serialize-sexp-internal ((object structure-object) stream serialization-state) ¶

Method: serialize-sexp-internal ((object hash-table) stream serialization-state) ¶

Method: serialize-sexp-internal ((object sequence) stream serialization-state) ¶

Method: serialize-sexp-internal ((object symbol) stream serialization-state) ¶

Method: serialize-sexp-internal ((object character) stream serialization-state) ¶

Method: serialize-sexp-internal ((object string) stream serialization-state) ¶

Method: serialize-sexp-internal ((object pathname) stream serialization-state) ¶

Method: serialize-sexp-internal ((object (eql t)) stream serialization-state) ¶

Method: serialize-sexp-internal ((object null) stream serialization-state) ¶

Method: serialize-sexp-internal ((object number) stream serialize-sexp-internal) ¶

Source: xml.lisp.

Generic Function: serialize-xml-internal (object stream serialization-state) ¶

Write a serialized version of object to stream using XML

Package

Source

xml.lisp.

Methods

Method: serialize-xml-internal ((object standard-object) stream serialization-state) ¶

Method: serialize-xml-internal ((object structure-object) stream serialization-state) ¶

Method: serialize-xml-internal ((object hash-table) stream serialization-state) ¶

Method: serialize-xml-internal ((object sequence) stream serialization-state) ¶

Method: serialize-xml-internal ((object symbol) stream serialization-state) ¶

Method: serialize-xml-internal ((object character) stream serialization-state) ¶

Method: serialize-xml-internal ((object string) stream serialization-state) ¶

Method: serialize-xml-internal ((object (eql t)) stream serialization-state) ¶

Method: serialize-xml-internal ((object null) stream serialization-state) ¶

Method: serialize-xml-internal ((object complex) stream serialization-state) ¶

Method: serialize-xml-internal ((object float) stream serialization-state) ¶

Method: serialize-xml-internal ((object ratio) stream serialization-state) ¶

Method: serialize-xml-internal ((object integer) stream serialization-state) ¶

Generic Function: set-known-object (serialization-state object) ¶

Package

Methods

Method: set-known-object ((serialization-state serialization-state) object) ¶

Source: serialization.lisp.

Generic Function: set-size-from-file (blob) ¶

Package

Methods

Method: set-size-from-file ((blob blob)) ¶

Source: blob.lisp.

Generic Function: size-from-file (blob) ¶

Package

Methods

Method: size-from-file ((blob blob)) ¶

Source: blob.lisp.

6.2.4 Classes

Class: serialization-state ¶

Package