Browse Source

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

Mukund Sivaraman 12 years ago
parent
commit
a69acbd2f9
1 changed files with 6 additions and 0 deletions
  1. 6 0
      src/lib/datasrc/rrset_collection.h

+ 6 - 0
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)