From: Francis Dupont Date: Wed, 23 Sep 2015 12:00:30 +0000 (+0200) Subject: [3984] Moved comment to its intended location X-Git-Tag: trac4074_base~7^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9687f44efee0ed37ef01a3b22f0926be0db60661;p=thirdparty%2Fkea.git [3984] Moved comment to its intended location --- diff --git a/src/lib/dhcpsrv/alloc_engine.h b/src/lib/dhcpsrv/alloc_engine.h index c0f5468c93..beec183900 100644 --- a/src/lib/dhcpsrv/alloc_engine.h +++ b/src/lib/dhcpsrv/alloc_engine.h @@ -505,29 +505,6 @@ public: /// "expired-reclaimed" or removing it from the lease databse, /// - updating statistics of assigned and reclaimed leases /// - /// Note: declined leases fall under the same expiration/reclaimation - /// processing as normal leases. In principle, it would more elegant - /// to have a separate processing for declined leases reclaimation. However, - /// due to performance reasons we decided to use them together. Several - /// aspects were taken into consideration. First, normal leases are expected - /// to expire frequently, so in a typical deployment this method will have - /// some leases to process. Second, declined leases are expected to be very - /// rare event, so in most cases there won't be any declined expired leases. - /// Third, the calls to LeaseMgr to obtain all leases of specific expiration - /// criteria are expensive, so it is better to have one call rather than - /// two, especially if one of those calls is expected to usually return no - /// leases. - /// - /// It doesn't make sense to retain declined leases that are reclaimed, - /// because those leases don't contain any useful information (all client - /// identifying information was stripped when the leave was moved to the - /// declined state). Therefore remove_leases parameter is ignored for - /// declined leases. They are always removed. - /// - /// Also, for delined leases @ref reclaimDeclined is called. It conducts - /// several declined specific operation (extra log entry, stats dump, - /// hooks). - /// /// @param max_leases Maximum number of leases to be reclaimed. /// @param timeout Maximum amount of time that the reclaimation routine /// may be processing expired leases, expressed in seconds. @@ -551,6 +528,29 @@ public: /// "expired-reclaimed" or removing it from the lease databse, /// - updating statistics of assigned and reclaimed leases /// + /// Note: declined leases fall under the same expiration/reclaimation + /// processing as normal leases. In principle, it would more elegant + /// to have a separate processing for declined leases reclaimation. However, + /// due to performance reasons we decided to use them together. Several + /// aspects were taken into consideration. First, normal leases are expected + /// to expire frequently, so in a typical deployment this method will have + /// some leases to process. Second, declined leases are expected to be very + /// rare event, so in most cases there won't be any declined expired leases. + /// Third, the calls to LeaseMgr to obtain all leases of specific expiration + /// criteria are expensive, so it is better to have one call rather than + /// two, especially if one of those calls is expected to usually return no + /// leases. + /// + /// It doesn't make sense to retain declined leases that are reclaimed, + /// because those leases don't contain any useful information (all client + /// identifying information was stripped when the leave was moved to the + /// declined state). Therefore remove_leases parameter is ignored for + /// declined leases. They are always removed. + /// + /// Also, for delined leases @ref reclaimDeclined is called. It conducts + /// several declined specific operation (extra log entry, stats dump, + /// hooks). + /// /// @param max_leases Maximum number of leases to be reclaimed. /// @param timeout Maximum amount of time that the reclaimation routine /// may be processing expired leases, expressed in seconds.