From: Tomek Mrugalski Date: Wed, 21 Oct 2015 14:05:59 +0000 (+0200) Subject: [3988] Documentation updated. X-Git-Tag: trac4231_base~33^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=125f433f90a7119ad89e1581b93f9b8b0dac2ac0;p=thirdparty%2Fkea.git [3988] Documentation updated. --- diff --git a/src/bin/dhcp4/dhcp4_hooks.dox b/src/bin/dhcp4/dhcp4_hooks.dox index 28e0e7eccf..30d4beb312 100644 --- a/src/bin/dhcp4/dhcp4_hooks.dox +++ b/src/bin/dhcp4/dhcp4_hooks.dox @@ -280,7 +280,8 @@ packet processing. Hook points that are not specific to packet processing - name: @b lease4, type: isc::dhcp::Lease4Ptr, direction: in - @b Description: this callout is executed for each declined lease that - has expired and is being recovered. The lease has already been stripped + has expired (was put aside for the duration of decline-probation-period) + and is being recovered. The lease has already been stripped from any client identifying information when it was put into declined state. In principle the callouts can modify the lease in this hook, but it makes little sense. There's no useful data in the lease, except diff --git a/src/bin/dhcp6/dhcp6_hooks.dox b/src/bin/dhcp6/dhcp6_hooks.dox index 211ba1efee..479d7a56a8 100644 --- a/src/bin/dhcp6/dhcp6_hooks.dox +++ b/src/bin/dhcp6/dhcp6_hooks.dox @@ -294,7 +294,8 @@ packet processing. Hook points that are not specific to packet processing - name: @b lease6, type: isc::dhcp::Lease6Ptr, direction: in - @b Description: this callout is executed for each declined lease that - has expired and is being recovered. The lease has already been stripped + has expired (was put aside for the duration of decline-probation-period) + and is being recovered. The lease has already been stripped from any client identifying information when it was put into declined state. In principle the callouts can modify the lease in this hook, but it makes little sense. There's no useful data in the lease, except diff --git a/src/lib/hooks/callout_handle.h b/src/lib/hooks/callout_handle.h index 16a488038e..a8ddfa4d1b 100644 --- a/src/lib/hooks/callout_handle.h +++ b/src/lib/hooks/callout_handle.h @@ -234,7 +234,7 @@ public: /// This variable is interrogated by the server to see if the remaining /// callouts associated with the current hook should be bypassed. /// - /// @param skip New value of the "skip" flag. + /// @param next New value of the next step status. void setStatus(const CalloutNextStep next) { next_step_ = next; }