From a181a097ccb607b834a7a982d225577bdccd6c16 Mon Sep 17 00:00:00 2001 From: Piotrek Zadroga Date: Tue, 19 Sep 2023 10:58:27 +0200 Subject: [PATCH] [#3067] addressed review comments --- src/bin/dhcp4/dhcp4_hooks.dox | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/src/bin/dhcp4/dhcp4_hooks.dox b/src/bin/dhcp4/dhcp4_hooks.dox index b650ee9ed4..c6e9f0862b 100644 --- a/src/bin/dhcp4/dhcp4_hooks.dox +++ b/src/bin/dhcp4/dhcp4_hooks.dox @@ -326,25 +326,22 @@ called before "subnet4_select". - name: @b old_lease, type: isc::dhcp::Lease4Ptr, direction: in - @b Description: this callout is executed when the server has received - DHCPDISCOVER from the client and the DHCPOFFER is yet to be sent back - to the client. The argument "query4" contains a pointer to an isc::dhcp::Pkt4 + DHCPDISCOVER from the client and the DHCPOFFER has been constructed but not + yet sent back. The argument "query4" contains a pointer to an isc::dhcp::Pkt4 object that contains all information regarding incoming DHCPDISCOVER packet. The "leases4" object will hold the pointer to the new candidate lease for this client. The "offer_lifetime" argument comes from the context information for the - DHCPv4 lease allocation. If "offer_lifetime" is not zero, it indicates that the - lease already exists in the lease store. The "old_lease" argument also comes from - the context information for the DHCPv4 lease allocation. If not Null, it is a pointer - to an old lease that the client had before. + DHCPv4 lease allocation. If "offer_lifetime" is not zero, it indicates that temporary + allocation on DHCPDISCOVER is enabled and the lease to be offered already exists in + the lease store. The "old_lease" argument also comes from the context information + for the DHCPv4 lease allocation. If not Null, it is a pointer to an old lease that + the client had before. - - Next step status: If any callout installed on the "lease4_offer" - sets the next step action to DROP, the server will drop the processed query. - The callout is responsible for dealing with Declined lease for the Offer that - in this case will NOT be sent back to the client. - If any callout installed on the "lease4_offer" sets the next step action to PARK, - the server will park the processed packet (hold packet processing) until the hook - libraries explicitly unpark the packet after they are done performing asynchronous - operations. Upon the packet UNPARK, the Offer will be sent to the client. - This was originally intended to be used by "ping-check" premium hook. + - Next step status: If any callout installed on the "lease4_offer" hook point + sets the next step action to DROP, the server will drop the processed query + and discard the prepared DHCPOFFER rather than sending it to the client. + Any further action, such as marking the discarded DHCPOFFER's lease as declined, + is the responsibility of the callout. @subsection dhcpv4HooksPkt4Send pkt4_send