The cl-prevalence Reference Manual

Parent

serialization (module)

Location

src/serialization/xml.lisp

Exported Definitions

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

Internal Definitions

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

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

Dependency

Parent

serialization (module)

Location

src/serialization/sexp.lisp

Exported Definitions

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

Internal Definitions

deserialize-sexp-internal (function)
print-symbol (function)
serialize-sexp-internal (generic function)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)
serialize-sexp-internal (method)

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

Dependency

serialization (module)

Parent

src (module)

Location

src/prevalence.lisp

Exported Definitions

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

Internal Definitions

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

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

Dependency

Parent

src (module)

Location

src/managed-prevalence.lisp

Exported Definitions

all-preferences-keys (generic function)
all-preferences-keys (method)
drop-index-on (function)
execute-transaction (macro)
find-all-objects (generic function)
find-all-objects (method)
find-object-with-id (generic function)
find-object-with-id (method)
find-object-with-slot (generic function)
find-object-with-slot (method)
get-id (generic function)
get-id (method)
get-preference (generic function)
get-preference (method)
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)

Internal Definitions

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

Parent

src (module)

Location

src/master-slave.lisp

Exported Definitions

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

Parent

src (module)

Location

src/blob.lisp

Exported Definitions

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

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 `cl-prevalence`

An implementation of Object Prevalence for Common Lisp

Source

package.lisp (file)

Use List

s-serialization
common-lisp

Exported Definitions

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

Internal Definitions

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

5.2 `s-serialization`

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

Source

package.lisp (file)

Use List

common-lisp

Used By List

Exported Definitions

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

Internal Definitions

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

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *blob-root*

The directory in which to store the blob files

Package: cl-prevalence
Source: blob.lisp (file)

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 (file)

6.1.3 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 (file)

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 (file)

Function: drop-index-on SYSTEM CLASS &optional SLOTS

Drop indexes on each of the slots provided

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

Function: index-on SYSTEM CLASS &optional SLOTS TEST

Create indexes on each of the slots provided.

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

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 (file)

Function: make-serialization-state ()

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

Package: s-serialization
Source: serialization.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: start-slave-server PREVALENCE-SYSTEM &key PORT

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

Package: cl-prevalence
Source: master-slave.lisp (file)

Function: stop-master-client PREVALENCE-SYTEM

Stop a connection from prevalence-system

Package: cl-prevalence
Source: master-slave.lisp (file)

Function: stop-slave-server SERVER

Package: cl-prevalence
Source: master-slave.lisp (file)

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 (file)

Function: tx-create-id-counter SYSTEM

Initialize the id counter to 0

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

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 (file)

Function: tx-delete-object SYSTEM CLASS ID

Delete the object of class with id from the system

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

Function: tx-set-preference SYSTEM KEY VALUE

Set the value of the persistent preference key in system

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

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 (file)

Generic Function: copy-to-stream BLOB BINARY-OUTPUT-STREAM

Copy the bytes from blob to binary-output-stream

Package

Source

blob.lisp (file)

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

blob.lisp (file)

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

blob.lisp (file)

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

blob.lisp (file)

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

blob.lisp (file)

Methods

Method: get-file (BLOB blob)

Generic Function: get-guard OBJECT

Access the guard function of a sytem

Package

Writer

(setf get-guard) (generic function)

Methods

Method: get-guard (GUARDED-PREVALENCE-SYSTEM guarded-prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Generic Function: (setf get-guard) NEW-VALUE OBJECT

Set the guard function of a system

Package

Reader

get-guard (generic function)

Methods

Method: (setf get-guard) NEW-VALUE (GUARDED-PREVALENCE-SYSTEM guarded-prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-id OBJECT

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

Package

Source

Methods

Method: get-id (OBJECT-WITH-ID object-with-id): automatically generated reader method

Generic Function: get-keywords BLOB

Return the list of keywords associated with blob

Package

Source

blob.lisp (file)

Writer

(setf get-keywords) (generic function)

Methods

Method: get-keywords (BLOB blob): automatically generated reader method

Generic Function: (setf get-keywords) KEYWORDS BLOB

Set the keywords list of blob

Package

Source

blob.lisp (file)

Reader

get-keywords (generic function)

Methods

Method: (setf get-keywords) NEW-VALUE (BLOB blob): automatically generated writer method

Generic Function: get-mime-type BLOB

Return the mime-type of blob as a string

Package

Source

blob.lisp (file)

Writer

(setf get-mime-type) (generic function)

Methods

Method: get-mime-type (BLOB blob): automatically generated reader method

Generic Function: (setf get-mime-type) MIME-TYPE BLOB

Set the mime-type string of blob

Package

Source

blob.lisp (file)

Reader

get-mime-type (generic function)

Methods

Method: (setf get-mime-type) NEW-VALUE (BLOB blob): automatically generated writer method

Generic Function: get-name BLOB

Return the descriptive name of blob

Package

Source

blob.lisp (file)

Writer

(setf get-name) (generic function)

Methods

Method: get-name (BLOB blob): automatically generated reader method

Generic Function: (setf get-name) NAME BLOB

Set the descriptive name of blob

Package

Source

blob.lisp (file)

Reader

get-name (generic function)

Methods

Method: (setf get-name) NEW-VALUE (BLOB blob): automatically generated writer method

Generic Function: get-option SYSTEM NAME

Retrieve a named option from system

Package

Source

Writer

(setf get-option) (generic function)

Methods

Method: get-option (SYSTEM prevalence-system) NAME

Generic Function: (setf get-option) VALUE SYSTEM NAME

Set a named option of system to value

Package

Source

Reader

get-option (generic function)

Methods

Method: (setf get-option) VALUE (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

Writer

(setf get-root-object) (generic function)

Methods

Method: get-root-object (SYSTEM prevalence-system) NAME

Generic Function: (setf get-root-object) VALUE SYSTEM NAME

Set a symbol named root object of system to value

Package

Source

Reader

get-root-object (generic function)

Methods

Method: (setf get-root-object) VALUE (SYSTEM prevalence-system) NAME

Generic Function: get-size BLOB

Return the size of blob in bytes

Package

Source

blob.lisp (file)

Methods

Method: get-size (BLOB blob) before

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

Generic Function: get-transaction-hook OBJECT

Generic Function: (setf get-transaction-hook) NEW-VALUE OBJECT

Package

Methods

Method: get-transaction-hook (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-transaction-hook) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

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 (file)

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

Methods

Method: reset-known-slots (SYSTEM prevalence-system) &optional CLASS

Source: prevalence.lisp (file)

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

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 Conditions

Condition: no-rollback-error ()

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

Package: cl-prevalence
Source: prevalence.lisp (file)
Direct superclasses: error (condition)
Direct methods: initiates-rollback (method)

6.1.6 Classes

Class: blob ()

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

Package

Source

blob.lisp (file)

Direct superclasses

object-with-id (class)

Direct methods

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

Direct slots

Slot: name

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

Slot: size

Initargs: :size
Initform: -1
Readers: get-size (generic function)

Slot: mime-type

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

Slot: keywords

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

Class: guarded-prevalence-system ()

A Prevalence system with a guard thunk

Package

Source

Direct superclasses

prevalence-system (class)

Direct methods

restore (method)
backup (method)
snapshot (method)
query (method)
execute (method)
get-guard (method)
get-guard (method)

Direct slots

Slot: guard

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

Class: object-with-id ()

Superclass for objects with an id

Package

Source

Direct superclasses

standard-object (class)

Direct subclasses

blob (class)

Direct methods

get-id (method)

Direct slots

Slot: id

Initargs: :id
Initform: -1
Readers: get-id (generic function)

Class: prevalence-system ()

Base Prevalence system implementation object

Package

Source

Direct superclasses

standard-object (class)

Direct subclasses

guarded-prevalence-system (class)

Direct methods

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

Direct slots

Slot: directory

Initargs: :directory
Readers: get-directory (generic function)
Writers: (setf get-directory) (generic function)

Slot: root-objects

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

Slot: options

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

Slot: snapshot

Readers: get-snapshot (generic function)
Writers: (setf get-snapshot) (generic function)

Slot: transaction-log

Readers: get-transaction-log (generic function)
Writers: (setf get-transaction-log) (generic function)

Slot: transaction-log-stream

Readers: get-transaction-log-stream (generic function)
Writers: (setf get-transaction-log-stream) (generic function)

Slot: serializer

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

Slot: deserializer

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

Slot: file-extension

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

Slot: serialization-state

Initform: (s-serialization:make-serialization-state)
Readers: get-serialization-state (generic function)

Slot: transaction-hook

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

Class: transaction ()

A simple Transaction object joining a function and its arguments

Package

Source

Direct superclasses

standard-object (class)

Direct methods

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

Direct slots

Slot: args

Initargs: :args
Readers: get-args (generic function)
Writers: (setf get-args) (generic function)

Slot: function

Initargs: :function
Initform: (quote identity)
Readers: get-function (generic function)
Writers: (setf get-function) (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: +cl-package+

Package: s-serialization
Source: serialization.lisp (file)

Constant: +keyword-package+

Package: s-serialization
Source: serialization.lisp (file)

6.2.2 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 (file)

Function: copy-file SOURCE TARGET

Package: cl-prevalence
Source: prevalence.lisp (file)

Function: copy-stream IN OUT &optional ELEMENT-TYPE

Copy everything from in to out

Package: cl-prevalence
Source: blob.lisp (file)

Function: deserialize-sexp-internal SEXP DESERIALIZED-OBJECTS

Package: s-serialization
Source: sexp.lisp (file)

Function: deserialize-xml-finish-element NAME ATTRIBUTES PARENT-SEED SEED

Package: s-serialization
Source: xml.lisp (file)

Function: deserialize-xml-new-element NAME ATTRIBUTES SEED

Package: s-serialization
Source: xml.lisp (file)

Function: deserialize-xml-text STRING SEED

Package: s-serialization
Source: xml.lisp (file)

Function: get-attribute-value NAME ATTRIBUTES

Package: s-serialization
Source: xml.lisp (file)

Function: get-objects-root-name CLASS

Return the keyword symbol naming the root of instances of class

Package: cl-prevalence
Source: managed-prevalence.lisp (file)

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 (file)

Function: print-symbol SYMBOL STREAM

Package: s-serialization
Source: sexp.lisp (file)

Function: print-symbol-xml SYMBOL STREAM

Package: s-serialization
Source: xml.lisp (file)

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 (file)

Function: sequence-type-and-length SEQUENCE

Package: s-serialization
Source: serialization.lisp (file)

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 (file)

Function: timetag &optional UNIVERSAL-TIME

Return a GMT string of universal-time as YYMMDDTHHMMSS

Package: cl-prevalence
Source: prevalence.lisp (file)

Function: truncate-file FILE POSITION

Truncate the physical file at position by copying and replacing it

Package: cl-prevalence
Source: prevalence.lisp (file)

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 (file)

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 (file)

6.2.3 Generic functions

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 (file)

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 (file)

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 Function: get-args OBJECT

Generic Function: (setf get-args) NEW-VALUE OBJECT

Package

Methods

Method: get-args (TRANSACTION transaction)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-args) NEW-VALUE (TRANSACTION transaction)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-counter OBJECT

Generic Function: (setf get-counter) NEW-VALUE OBJECT

Package

Methods

Method: get-counter (SERIALIZATION-STATE serialization-state)

automatically generated reader method

Source: serialization.lisp (file)

Method: (setf get-counter) NEW-VALUE (SERIALIZATION-STATE serialization-state)

automatically generated writer method

Source: serialization.lisp (file)

Generic Function: get-deserializer OBJECT

Generic Function: (setf get-deserializer) NEW-VALUE OBJECT

Package

Methods

Method: get-deserializer (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-deserializer) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-directory OBJECT

Generic Function: (setf get-directory) NEW-VALUE OBJECT

Package

Methods

Method: get-directory (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-directory) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-file-extension OBJECT

Generic Function: (setf get-file-extension) NEW-VALUE OBJECT

Package

Methods

Method: get-file-extension (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-file-extension) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-function OBJECT

Generic Function: (setf get-function) NEW-VALUE OBJECT

Package

Methods

Method: get-function (TRANSACTION transaction)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-function) NEW-VALUE (TRANSACTION transaction)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-hashtable OBJECT

Package

Methods

Method: get-hashtable (SERIALIZATION-STATE serialization-state)

automatically generated reader method

Source: serialization.lisp (file)

Generic Function: get-root-objects OBJECT

Generic Function: (setf get-root-objects) NEW-VALUE OBJECT

Package

Methods

Method: get-root-objects (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-root-objects) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-serializable-slots SERIALIZATION-STATE OBJECT

Package

Methods

Method: get-serializable-slots (SERIALIZATION-STATE serialization-state) OBJECT

Source: serialization.lisp (file)

Generic Function: get-serialization-state OBJECT

Package

Methods

Method: get-serialization-state (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Generic Function: get-serializer OBJECT

Generic Function: (setf get-serializer) NEW-VALUE OBJECT

Package

Methods

Method: get-serializer (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-serializer) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-snapshot OBJECT

Generic Function: (setf get-snapshot) NEW-VALUE OBJECT

Package

Methods

Method: get-snapshot (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-snapshot) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

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 (file)

Generic Function: get-transaction-log OBJECT

Generic Function: (setf get-transaction-log) NEW-VALUE OBJECT

Package

Methods

Method: get-transaction-log (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-transaction-log) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

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 (file)

Generic Function: get-transaction-log-stream OBJECT

Generic Function: (setf get-transaction-log-stream) NEW-VALUE OBJECT

Package

Methods

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

Source: prevalence.lisp (file)

Method: get-transaction-log-stream (PREVALENCE-SYSTEM prevalence-system)

automatically generated reader method

Source: prevalence.lisp (file)

Method: (setf get-transaction-log-stream) NEW-VALUE (PREVALENCE-SYSTEM prevalence-system)

automatically generated writer method

Source: prevalence.lisp (file)

Generic Function: get-xml-parser-state SERIALIZATION-STATE

Package

Methods

Method: get-xml-parser-state (SERIALIZATION-STATE serialization-state)

Source: serialization.lisp (file)

Generic Function: known-object-id SERIALIZATION-STATE OBJECT

Package

Methods

Method: known-object-id (SERIALIZATION-STATE serialization-state) OBJECT

Source: serialization.lisp (file)

Generic Function: log-transaction SYSTEM TRANSACTION

Package

Methods

Method: log-transaction (SYSTEM prevalence-system) (TRANSACTION transaction) after

Execute the transaction-hook

Source: prevalence.lisp (file)

Method: log-transaction (SYSTEM prevalence-system) (TRANSACTION transaction)

Log transaction for system

Source: prevalence.lisp (file)

Generic Function: reset SERIALIZATION-STATE

Package

Methods

Method: reset (SERIALIZATION-STATE serialization-state)

Source: serialization.lisp (file)

Generic Function: serialize-sexp-internal OBJECT STREAM SERIALIZATION-STATE

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

Package

Source

sexp.lisp (file)

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 (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 (file)

Generic Function: serialize-xml-internal OBJECT STREAM SERIALIZATION-STATE

Write a serialized version of object to stream using XML

Package

Source

xml.lisp (file)

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 (file)

Generic Function: set-size-from-file BLOB

Package

Methods

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

Source: blob.lisp (file)

Generic Function: size-from-file BLOB

Package

Methods

Method: size-from-file (BLOB blob)

Source: blob.lisp (file)

6.2.4 Classes

Class: serialization-state ()

Package

Source