Update of /project/cl-prevalence/cvsroot/public_html In directory clnet:/tmp/cvs-serv17512
Modified Files: CL-PREVALENCE.html Log Message: documentation update
--- /project/cl-prevalence/cvsroot/public_html/CL-PREVALENCE.html 2004/06/21 14:34:01 1.1 +++ /project/cl-prevalence/cvsroot/public_html/CL-PREVALENCE.html 2007/03/29 11:51:17 1.2 @@ -15,6 +15,8 @@ <blockquote>Copy the bytes from blob to binary-output-stream</blockquote> <p>(<b>destroy</b> blob) <i>generic-function</i></p> <blockquote>Completely destroy blob (removing its byte data file as well)</blockquote> +<p>(<b>drop-index-on</b> system class &optional slots) <i>function</i></p> +<blockquote>Drop indexes on each of the slots provided</blockquote> <p>(<b>execute</b> system object) <i>generic-function</i></p> <blockquote>Ask for a transaction object to be executed on system with ACID properties</blockquote> <p>(<b>execute-transaction</b> transaction-call) <i>function</i></p> @@ -27,6 +29,8 @@ <blockquote>Return an unordered collection of all objects in system that are instances of class</blockquote> <p>(<b>find-object-with-id</b> system class id) <i>generic-function</i></p> <blockquote>Find and return the object in system of class with id, null if not found</blockquote> +<p>(<b>find-object-with-slot</b> system class slot value &optional test) <i>generic-function</i></p> +<blockquote>Find and return the object in system of class with slot equal to value, null if not found</blockquote> <p>(<b>get-file</b> blob) <i>generic-function</i></p> <blockquote>Return the pathname to the bytes of blob</blockquote> <p>(<b>get-guard</b> guarded-prevalence-system) <i>generic-function</i></p> @@ -62,10 +66,12 @@ <p><b>guarded-prevalence-system</b> <i>class</i></p> <blockquote>A Prevalence system with a guard thunk</blockquote> <blockquote>Class precedence list: <tt> guarded-prevalence-system prevalence-system standard-object t</tt></blockquote> -<blockquote>Class init args: <tt> :directory</tt></blockquote> +<blockquote>Class init args: <tt> :directory :serializer :deserializer :file-extension :transaction-hook</tt></blockquote> +<p>(<b>index-on</b> system class &optional slots (test (quote equalp))) <i>function</i></p> +<blockquote>Create indexes on each of the slots provided.</blockquote> <p>(<b>initiates-rollback</b> condition) <i>generic-function</i></p> <blockquote>Return true when a condition initiates a rollback when thrown from a transaction</blockquote> -<p>(<b>make-prevalence-system</b> directory &key (prevalence-system-class (quote prevalence-system))) <i>function</i></p> +<p>(<b>make-prevalence-system</b> directory &key (prevalence-system-class (quote prevalence-system)) init-args) <i>function</i></p> <blockquote>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 @@ -85,37 +91,35 @@ <p><b>prevalence-system</b> <i>class</i></p> <blockquote>Base Prevalence system implementation object</blockquote> <blockquote>Class precedence list: <tt> prevalence-system standard-object t</tt></blockquote> -<blockquote>Class init args: <tt> :directory</tt></blockquote> -<p>(<b>print-snapshot</b> system) <i>function</i></p> -<blockquote>Echo the XML making up the snapshot of system to t</blockquote> -<p>(<b>print-transaction-log</b> system) <i>function</i></p> -<blockquote>Echo the XML making up the transaction log of system to t</blockquote> +<blockquote>Class init args: <tt> :transaction-hook :file-extension :deserializer :serializer :directory</tt></blockquote> <p>(<b>query</b> system function &rest args) <i>generic-function</i></p> <blockquote>Ask for a query function to be executed on system with args</blockquote> <p>(<b>remove-root-object</b> system name) <i>generic-function</i></p> <blockquote>Remove the root object by symbol name from system</blockquote> <p>(<b>restore</b> system) <i>generic-function</i></p> <blockquote>Restore a system from permanent storage</blockquote> -<p>(<b>set-slot-values</b> instance slots-and-values) <i>function</i></p> -<blockquote>Set slots and values of instance</blockquote> -<p>(<b>show-transaction-log</b> system) <i>function</i></p> -<blockquote>Print the transaction objects making up the transaction log of system to t</blockquote> <p>(<b>snapshot</b> system) <i>generic-function</i></p> <blockquote>Take a snapshot of a system</blockquote> +<p>(<b>start-master-client</b> prevalence-system &key (host localhost) (port 7651)) <i>function</i></p> +<blockquote>Start a connection to host:port to deliver transactions from prevalence-system</blockquote> +<p>(<b>start-slave-server</b> prevalence-system &key (port 7651)) <i>function</i></p> +<blockquote>Start a server on port accepting transactions to be executed on prevalence-system</blockquote> +<p>(<b>stop-master-client</b> prevalence-sytem) <i>function</i></p> +<blockquote>Stop a connection from prevalence-system</blockquote> +<p>(<b>totally-destroy</b> system &key abort) <i>generic-function</i></p> +<blockquote>Totally destroy system from permanent storage by deleting any files that we find</blockquote> <p><b>transaction</b> <i>class</i></p> <blockquote>A simple Transaction object joining a function and its arguments</blockquote> <blockquote>Class precedence list: <tt> transaction standard-object t</tt></blockquote> <blockquote>Class init args: <tt> :function :args</tt></blockquote> -<p>(<b>transaction-log-tail</b> system &optional (count 8)) <i>function</i></p> -<blockquote>Return a list of the count last transaction objects of system</blockquote> <p>(<b>tx-change-object-slots</b> system class id slots-and-values) <i>function</i></p> <blockquote>Change some slots of the object of class with id in system using slots and values</blockquote> <p>(<b>tx-create-id-counter</b> system) <i>function</i></p> <blockquote>Initialize the id counter to 0</blockquote> -<p>(<b>tx-create-object</b> system &optional class slots-and-values) <i>function</i></p> +<p>(<b>tx-create-object</b> system class &optional slots-and-values) <i>function</i></p> <blockquote>Create a new object of class in system, assigning it a unique id, optionally setting some slots and values</blockquote> <p>(<b>tx-delete-object</b> system class id) <i>function</i></p> -<blockquote>Delete the object of class with if from the system</blockquote> +<blockquote>Delete the object of class with id from the system</blockquote> <p>(<b>tx-set-preference</b> system key value) <i>function</i></p> <blockquote>Set the value of the persistent preference key in system</blockquote> -<font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on LispWorks</p></font></body></html> +<font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on LispWorks</p></font></body></html> \ No newline at end of file