Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-prevalence Reference Manual, version 6, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:05:12 2022 GMT+0.
• Introduction | What cl-prevalence is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
============= CL-PREVALENCE ============= .. image:: https://github.com/40ants/cl-prevalence/workflows/CI/badge.svg This fork is available from Quicklisp and Ultralisp.org. Running tests ------------- To run all tests, eval this in the REPL: ``` (asdf:test-system :cl-prevalence) ``` GitHub should run the testsuite for each pull-request automatically. History ------- This is a fork of cl-prevalence, taken from https://bitbucket.org/skypher/cl-prevalence It is forked from commit 8eef33bfa789 (Mon Jul 05 17:53:21 2010 +0200) by Leslie Polzer.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-prevalence system |
Alexander Artemenko <svetlyak.40wt@gmail.com>
Sven Van Caekenberghe <svc@mac.com>
Lesser Lisp General Public License
Common Lisp Prevalence Package
Common Lisp Prevalence is an implementation of Object Prevalence for Common Lisp
6
cl-prevalence.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The cl-prevalence/src module | ||
• The cl-prevalence/src/serialization module |
Next: The cl-prevalence/src/serialization module, Previous: Modules, Up: Modules [Contents][Index]
cl-prevalence (system)
src/
Previous: The cl-prevalence/src module, Up: Modules [Contents][Index]
package.lisp (file)
src (module)
src/serialization/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The cl-prevalence/src/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-prevalence.asd
cl-prevalence (system)
Next: The cl-prevalence/src/serialization/serialization․lisp file, Previous: The cl-prevalence․asd file, Up: Lisp files [Contents][Index]
src (module)
src/package.lisp
Next: The cl-prevalence/src/serialization/xml․lisp file, Previous: The cl-prevalence/src/package․lisp file, Up: Lisp files [Contents][Index]
serialization (module)
src/serialization/serialization.lisp
Next: The cl-prevalence/src/serialization/sexp․lisp file, Previous: The cl-prevalence/src/serialization/serialization․lisp file, Up: Lisp files [Contents][Index]
serialization.lisp (file)
serialization (module)
src/serialization/xml.lisp
Next: The cl-prevalence/src/prevalence․lisp file, Previous: The cl-prevalence/src/serialization/xml․lisp file, Up: Lisp files [Contents][Index]
serialization.lisp (file)
serialization (module)
src/serialization/sexp.lisp
Next: The cl-prevalence/src/managed-prevalence․lisp file, Previous: The cl-prevalence/src/serialization/sexp․lisp file, Up: Lisp files [Contents][Index]
serialization (module)
src (module)
src/prevalence.lisp
Next: The cl-prevalence/src/master-slave․lisp file, Previous: The cl-prevalence/src/prevalence․lisp file, Up: Lisp files [Contents][Index]
prevalence.lisp (file)
src (module)
src/managed-prevalence.lisp
Next: The cl-prevalence/src/blob․lisp file, Previous: The cl-prevalence/src/managed-prevalence․lisp file, Up: Lisp files [Contents][Index]
prevalence.lisp (file)
src (module)
src/master-slave.lisp
Previous: The cl-prevalence/src/master-slave․lisp file, Up: Lisp files [Contents][Index]
managed-prevalence.lisp (file)
src (module)
src/blob.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-prevalence package | ||
• The s-serialization package |
Next: The s-serialization package, Previous: Packages, Up: Packages [Contents][Index]
An implementation of Object Prevalence for Common Lisp
package.lisp (file)
Previous: The cl-prevalence package, Up: Packages [Contents][Index]
XML and s-expression based serialization for Common Lisp and CLOS
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported classes |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The directory in which to store the blob files
blob.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Create a transaction object from transaction-call and execute it
managed-prevalence.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Read and return an s-expression serialized version of a lisp object from stream, optionally reusing a serialization state
sexp.lisp (file)
Read and return an XML serialized version of a lisp object from stream, optionally reusing a serialization state
xml.lisp (file)
Drop indexes on each of the slots provided
managed-prevalence.lisp (file)
Create indexes on each of the slots provided.
managed-prevalence.lisp (file)
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.
prevalence.lisp (file)
Create a reusable serialization state to pass as optional argument to [de]serialize-xml
serialization.lisp (file)
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.
prevalence.lisp (file)
Write a serialized version of object to stream using s-expressions, optionally reusing a serialization-state
sexp.lisp (file)
Write a serialized version of object to stream using XML, optionally reusing a serialization-state
xml.lisp (file)
Start a connection to host:port to deliver transactions from prevalence-system
master-slave.lisp (file)
Start a server on port accepting transactions to be executed on prevalence-system Returns a thread object
master-slave.lisp (file)
Stop a connection from prevalence-system
master-slave.lisp (file)
master-slave.lisp (file)
Change some slots of the object of class with id in system using slots and values
managed-prevalence.lisp (file)
Initialize the id counter to 0
managed-prevalence.lisp (file)
Create a new object of class in system, assigning it a unique id, optionally setting some slots and values
managed-prevalence.lisp (file)
Delete the object of class with id from the system
managed-prevalence.lisp (file)
Set the value of the persistent preference key in system
managed-prevalence.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Return a list of all persistent preference keys of system
managed-prevalence.lisp (file)
Return a list of all persistent preference keys of system
Make backup copies of the current snapshot and transaction-log files
prevalence.lisp (file)
Do a backup on a system controlled by a guard
Make backup copies of the current snapshot and transaction-log files
Close all open stream associated with system (optionally aborting operations in progress)
prevalence.lisp (file)
Copy the bytes from blob to binary-output-stream
blob.lisp (file)
Copy the bytes from blob to binary-output-stream
Completely destroy blob (removing its byte data file as well)
blob.lisp (file)
Ask for a transaction object to be executed on system with ACID properties
prevalence.lisp (file)
Execute a transaction on a system controlled by a guard
Execute a transaction on a system and log it to the transaction log
Fill the blob’s contents with the bytes read from the binary file at pathname
blob.lisp (file)
Fill the blob’s contents with the bytes read from the binary file at pathname
Fill the blob’s contents with the bytes from binary-input-stream
blob.lisp (file)
Fill the blob’s contents with the bytes from binary-input-stream
Return an unordered collection of all objects in system that are instances of class
managed-prevalence.lisp (file)
Return an unordered collection of all objects in system that are instances of class
Find and return the object in system of class with id, null if not found
managed-prevalence.lisp (file)
Find and return the object in system of class with id, null if not found
Find and return the object in system of class with slot equal to value, null if not found
managed-prevalence.lisp (file)
Find and return the object in system of class with slot equal to value, null if not found
Return the pathname to the bytes of blob
blob.lisp (file)
Access the guard function of a sytem
(setf get-guard) (generic function)
automatically generated reader method
prevalence.lisp (file)
Set the guard function of a system
get-guard (generic function)
automatically generated writer method
prevalence.lisp (file)
Return an external, unique, immutable identifier for object (typically an integer)
managed-prevalence.lisp (file)
automatically generated reader method
Return the list of keywords associated with blob
blob.lisp (file)
(setf get-keywords) (generic function)
automatically generated reader method
Set the keywords list of blob
blob.lisp (file)
get-keywords (generic function)
automatically generated writer method
Return the mime-type of blob as a string
blob.lisp (file)
(setf get-mime-type) (generic function)
automatically generated reader method
Set the mime-type string of blob
blob.lisp (file)
get-mime-type (generic function)
automatically generated writer method
Return the descriptive name of blob
blob.lisp (file)
(setf get-name) (generic function)
automatically generated reader method
Set the descriptive name of blob
Retrieve a named option from system
prevalence.lisp (file)
(setf get-option) (generic function)
Set a named option of system to value
prevalence.lisp (file)
get-option (generic function)
Retrieve the value of the persistent preference stored under key in system
managed-prevalence.lisp (file)
Retrieve the value of the persistent preference stored under key in system
Retrieve a root object by symbol name from system
prevalence.lisp (file)
(setf get-root-object) (generic function)
Set a symbol named root object of system to value
prevalence.lisp (file)
get-root-object (generic function)
Return the size of blob in bytes
blob.lisp (file)
automatically generated reader method
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
Return true when a condition initiates a rollback when thrown from a transaction
prevalence.lisp (file)
Increment and return the next id
managed-prevalence.lisp (file)
Ask for a query function to be executed on system with args
prevalence.lisp (file)
Execute an exclusive query function on a sytem controlled by a guard
Execute an exclusive query function on a sytem
Remove the root object by symbol name from system
prevalence.lisp (file)
Clear the caching of known slots for class, or for all classes if class is nil
serialization.lisp (file)
prevalence.lisp (file)
Restore a system from permanent storage
prevalence.lisp (file)
Restore a system controlled by a guard
Load a system from persistent storage starting from the last snapshot and replaying the transaction log
Return a list of slot names that need serialization
serialization.lisp (file)
Take a snapshot of a system
prevalence.lisp (file)
Make a snapshot of a system controlled by a guard
Write to whole system to persistent storage resetting the transaction log
Totally destroy system from permanent storage by deleting any files that we find
prevalence.lisp (file)
Totally destroy system from permanent storage by deleting any files used by the system, remove all root objects
Next: Exported classes, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
Thrown by code inside a transaction to indicate that no rollback is needed
prevalence.lisp (file)
error (condition)
initiates-rollback (method)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
A blob is a file-like collection of bytes with related metadata
blob.lisp (file)
object-with-id (class)
:name
"untitled"
get-name (generic function)
(setf get-name) (generic function)
:size
-1
get-size (generic function)
:mime-type
"application/octet-stream"
get-mime-type (generic function)
(setf get-mime-type) (generic function)
:keywords
(quote nil)
get-keywords (generic function)
(setf get-keywords) (generic function)
A Prevalence system with a guard thunk
prevalence.lisp (file)
prevalence-system (class)
(function (lambda (cl-prevalence::thunk) (funcall cl-prevalence::thunk)))
get-guard (generic function)
(setf get-guard) (generic function)
Superclass for objects with an id
managed-prevalence.lisp (file)
standard-object (class)
blob (class)
get-id (method)
:id
-1
get-id (generic function)
Base Prevalence system implementation object
prevalence.lisp (file)
standard-object (class)
guarded-prevalence-system (class)
:directory
get-directory (generic function)
(setf get-directory) (generic function)
(make-hash-table :test (quote eq))
get-root-objects (generic function)
(setf get-root-objects) (generic function)
(make-hash-table :test (quote eq))
get-snapshot (generic function)
(setf get-snapshot) (generic function)
get-transaction-log (generic function)
(setf get-transaction-log) (generic function)
get-transaction-log-stream (generic function)
(setf get-transaction-log-stream) (generic function)
:serializer
(function s-serialization:serialize-xml)
get-serializer (generic function)
(setf get-serializer) (generic function)
:deserializer
(function s-serialization:deserialize-xml)
get-deserializer (generic function)
(setf get-deserializer) (generic function)
:file-extension
"xml"
get-file-extension (generic function)
(setf get-file-extension) (generic function)
(s-serialization:make-serialization-state)
get-serialization-state (generic function)
:transaction-hook
(function identity)
get-transaction-hook (generic function)
(setf get-transaction-hook) (generic function)
A simple Transaction object joining a function and its arguments
prevalence.lisp (file)
standard-object (class)
:args
get-args (generic function)
(setf get-args) (generic function)
:function
(quote identity)
get-function (generic function)
(setf get-function) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal classes |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
serialization.lisp (file)
serialization.lisp (file)
Next: Internal generic functions, Previous: Internal constants, Up: Internal definitions [Contents][Index]
Add an index entry using this slot to this object
managed-prevalence.lisp (file)
prevalence.lisp (file)
Copy everything from in to out
blob.lisp (file)
sexp.lisp (file)
xml.lisp (file)
xml.lisp (file)
xml.lisp (file)
xml.lisp (file)
Return the keyword symbol naming the root of instances of class
managed-prevalence.lisp (file)
Return the keyword symbol naming the specified index of instances of class.
managed-prevalence.lisp (file)
sexp.lisp (file)
xml.lisp (file)
Remove the index entry using this slot to this object
managed-prevalence.lisp (file)
serialization.lisp (file)
Return true when slot in object is not eql to value (or when the slot was unbound)
managed-prevalence.lisp (file)
Return a GMT string of universal-time as YYMMDDTHHMMSS
prevalence.lisp (file)
Truncate the physical file at position by copying and replacing it
prevalence.lisp (file)
Create an index for this object on this slot, with an optional test for the hash table (add existing objects)
managed-prevalence.lisp (file)
Remove an index for this object on this slot
managed-prevalence.lisp (file)
Next: Internal classes, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Read and return an s-expression serialized version of a Lisp class from stream.
sexp.lisp (file)
Read and return an s-expression serialized version of a Lisp struct from stream.
sexp.lisp (file)
Extend with your own types by overloading serialize-xml-internal and implementing deserialize aux functions
xml.lisp (file)
Extend with your own types by overloading serialize-xml-internal and implementing deserialize aux functions
xml.lisp (file)
Ask for a transaction object to execute its changes in the context of system
prevalence.lisp (file)
Execute a transaction itself in the context of a system
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
serialization.lisp (file)
automatically generated writer method
serialization.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
serialization.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
serialization.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
Return the name of the snapshot filename, optionally using a suffix
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
Return the name of the transaction-log filename, optionally using a suffix
prevalence.lisp (file)
prevalence.lisp (file)
automatically generated reader method
prevalence.lisp (file)
automatically generated writer method
prevalence.lisp (file)
serialization.lisp (file)
serialization.lisp (file)
Execute the transaction-hook
prevalence.lisp (file)
Log transaction for system
prevalence.lisp (file)
serialization.lisp (file)
Write a serialized version of object to stream using s-expressions
sexp.lisp (file)
xml.lisp (file)
Write a serialized version of object to stream using XML
xml.lisp (file)
serialization.lisp (file)
blob.lisp (file)
blob.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
serialization.lisp (file)
standard-object (class)
0
get-counter (generic function)
(setf get-counter) (generic function)
(make-hash-table :test (quote eq) :size 1024 :rehash-size 2.0)
get-hashtable (generic function)
(make-hash-table)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L M |
---|
Jump to: | C F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | (
A B C D E F G I K L M N P Q R S T |
---|
Jump to: | (
A B C D E F G I K L M N P Q R S T |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
A C D F G H I K M N O R S T X |
---|
Jump to: | *
+
A C D F G H I K M N O R S T X |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | B C G N O P S T |
---|
Jump to: | B C G N O P S T |
---|