From: Mukund Sivaraman <muks@isc.org>
Date: Wed, 9 Jan 2013 05:14:26 +0000 (+0530)
Subject: [2435] Describe that a reference to the updater is kept
X-Git-Tag: bind10-1.0.0-rc-release~126
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a69acbd2f9dde5eb533b95ef0d538495e733dcd2;p=thirdparty%2Fkea.git

[2435] Describe that a reference to the updater is kept
---

diff --git a/src/lib/datasrc/rrset_collection.h b/src/lib/datasrc/rrset_collection.h
index df307c726f..4effd4fb48 100644
--- a/src/lib/datasrc/rrset_collection.h
+++ b/src/lib/datasrc/rrset_collection.h
@@ -26,6 +26,12 @@ namespace datasrc {
 class RRsetCollection : public isc::dns::RRsetCollectionBase {
 public:
     /// \brief Constructor.
+    ///
+    /// A reference to the \c updater (via \c shared_ptr) is taken when
+    /// the collection is constructed. As long as the collection object
+    /// is alive, the reference to the updater is kept and it cannot be
+    /// destroyed by the client.
+    ///
     /// \param updater The ZoneUpdater to wrap around.
     RRsetCollection(ZoneUpdaterPtr updater) :
         updater_(updater)