summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcin Siodelski <marcin@isc.org>2015-09-10 19:58:55 +0200
committerMarcin Siodelski <marcin@isc.org>2015-09-11 09:43:05 +0200
commitd172fb500896515acd07fb9005453fb65e61ed69 (patch)
treec263a2bce394990d90bef299ae9e06a3d2916bb0
parent[3973] Update statistics when the lease is reclaimed. (diff)
downloadkea-d172fb500896515acd07fb9005453fb65e61ed69.tar.xz
kea-d172fb500896515acd07fb9005453fb65e61ed69.zip
[3973] Updated descriptions of lease reclamation routines in alloc_engine.h
-rw-r--r--src/lib/dhcpsrv/alloc_engine.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/lib/dhcpsrv/alloc_engine.h b/src/lib/dhcpsrv/alloc_engine.h
index e5f1c53212..b15d19cc8a 100644
--- a/src/lib/dhcpsrv/alloc_engine.h
+++ b/src/lib/dhcpsrv/alloc_engine.h
@@ -497,6 +497,14 @@ public:
/// See http://kea.isc.org/wiki/LeaseExpirationDesign#LeasesReclamationRoutine
/// for the details.
///
+ /// This method is executed periodically to act upon expired leases. This
+ /// includes for each lease:
+ /// - executing "lease_expire6" hook,
+ /// - removing DNS record for a lease,
+ /// - reclaiming a lease in the database, i.e. setting its state to
+ /// "expired-reclaimed" or removing it from the lease databse,
+ /// - updating statistics of assigned and reclaimed leases
+ ///
/// @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.
@@ -512,6 +520,14 @@ public:
/// See http://kea.isc.org/wiki/LeaseExpirationDesign#LeasesReclamationRoutine
/// for the details.
///
+ /// This method is executed periodically to act upon expired leases. This
+ /// includes for each lease:
+ /// - executing "lease_expire6" hook,
+ /// - removing DNS record for a lease,
+ /// - reclaiming a lease in the database, i.e. setting its state to
+ /// "expired-reclaimed" or removing it from the lease databse,
+ /// - updating statistics of assigned and reclaimed leases
+ ///
/// @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.