aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.xhtml
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2016-05-13 01:50:13 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2016-05-13 01:50:13 +0200
commitfd6249f4d39eb4dd4f6bb625924cd69d191f875e (patch)
tree077b6ad3b37c566d205bea3db13f5d1be5c20ce8 /doc/manual.xhtml
parent6c0eb73a3c45e6eb11a8bcf4dade971306c47ed6 (diff)
Clarify lazy_ptr usage in manual
Diffstat (limited to 'doc/manual.xhtml')
-rw-r--r--doc/manual.xhtml9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/manual.xhtml b/doc/manual.xhtml
index 11c1350..b16e1ce 100644
--- a/doc/manual.xhtml
+++ b/doc/manual.xhtml
@@ -7496,7 +7496,8 @@ public:
// The eager pointer interface.
//
- // Initialization/assignment from an eager pointer.
+ // Initialization/assignment from an eager pointer to a
+ // transient object.
//
public:
template &lt;class Y> lazy_ptr (const eager_ptr&lt;Y>&amp;);
@@ -7550,6 +7551,12 @@ public:
};
</pre>
+ <p>Note that to initialize a lazy pointer to a persistent object from
+ its eager pointer one must use the constructor or <code>reset()</code>
+ function with the database as its first argument. The database is
+ required to support comparison of unloaded lazy pointers to persistent
+ objects.</p>
+
<p>In a lazy weak pointer interface, the <code>load()</code> function
returns the <em>strong</em> (shared) eager pointer. The following
transaction demonstrates the use of a lazy weak pointer based on