Changeset 7428

Timestamp:

Jun 8, 2006, 10:05:47 AM (20 years ago)

Author:

Paul Price

Message:

Adding p_psMemAllocatePersistent, per bug 753.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.398 2006-06-07 04:06:37 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.399 2006-06-08 20:05:47 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -445 +445 @@
 \end{prototype}
 
+Sometimes system code will need to allocate complex structures (such
+as a \code{psMetadata}) that must all be marked as \code{persistent}.
+To save this code the trouble of tracking down every allocated pointer
+to mark each \code{persistent}, we define an additional private
+function, \code{p_psMemAllocatePersistent}, that sets the use of
+\code{persistent} within \code{psAlloc}.  This allows us to call
+\code{p_psMemAllocatePersistent(true)}, allocate all our persistent
+memory, and then call \code{p_psMemAllocatePersistent(false)}.  The
+initial setting shall be for allocated memory not to be marked
+\code{persistent}.
+\begin{prototype}
+bool p_psMemAllocatePersistent(bool is_persistent);
+\end{prototype}
 
 The \code{psMemBlock} structure element \code{refCounter} is provided