From 925cd4592b2117f887a7e326859773790bc158a9 Mon Sep 17 00:00:00 2001
From: Tomek Mrugalski <tomasz@isc.org>
Date: Wed, 29 Mar 2017 11:49:36 -0500
Subject: [PATCH] [5132] Developer's guide update for new hooks

---
 src/bin/dhcp4/dhcp4_hooks.dox | 16 ++++++++++++++++
 src/bin/dhcp6/dhcp6_hooks.dox | 16 ++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/src/bin/dhcp4/dhcp4_hooks.dox b/src/bin/dhcp4/dhcp4_hooks.dox
index 1371cc3d2d..691c4807ba 100644
--- a/src/bin/dhcp4/dhcp4_hooks.dox
+++ b/src/bin/dhcp4/dhcp4_hooks.dox
@@ -108,6 +108,22 @@ to the end of this list.
    sets the next step status to SKIP, the server will not select any subnet.
    Packet processing will continue, but will be severely limited.
 
+@subsection dhcpv4HooksHost4Identifier host4_identifier
+
+ - @b Arguments:
+   - name: @b query4, type isc::dhcp::Pkt4Ptr, direction: <b>in</b>
+   - name: @b id_type, type isc::dhcp::Host::IdentifierType, direction: <b>in/out</b>
+   - name: @b id_value, type std::vector<uint8_t>, direction: <b>out</b>
+
+ - @b Description: this callout is executed only if flexible identifers are
+   enabled, i.e. host-reservation-identifiers contain 'flex-id' value. This
+   callout enables external library to provide values for flexible identifers.
+   To be able to use this feature, flex_id hook library is needed.
+
+ - <b>Next step status</b>: If a callout installed on the "host4_identifier" hook
+   point sets the next step status to value other than NEXT_STEP_CONTINUE, the
+   identifier will not be used.
+
 @subsection dhcpv4HooksLeaseSelect lease4_select
 
  - @b Arguments:
diff --git a/src/bin/dhcp6/dhcp6_hooks.dox b/src/bin/dhcp6/dhcp6_hooks.dox
index ae9bbe844a..8da1d68384 100644
--- a/src/bin/dhcp6/dhcp6_hooks.dox
+++ b/src/bin/dhcp6/dhcp6_hooks.dox
@@ -109,6 +109,22 @@ to the end of this list.
    sets the status to SKIP, the server will not select any subnet. Packet processing
    will continue, but will be severely limited.
 
+@subsection dhcpv6HooksHost6Identifier host6_identifier
+
+ - @b Arguments:
+   - name: @b query6, type isc::dhcp::Pkt6Ptr, direction: <b>in</b>
+   - name: @b id_type, type isc::dhcp::Host::IdentifierType, direction: <b>in/out</b>
+   - name: @b id_value, type std::vector<uint8_t>, direction: <b>out</b>
+
+ - @b Description: this callout is executed only if flexible identifers are
+   enabled, i.e. host-reservation-identifiers contain 'flex-id' value. This
+   callout enables external library to provide values for flexible identifers.
+   To be able to use this feature, flex_id hook library is needed.
+
+ - <b>Next step status</b>: If a callout installed on the "host6_identifier" hook
+   point sets the next step status to value other than NEXT_STEP_CONTINUE, the
+   identifier will not be used.
+
 @subsection dhcpv6HooksLease6Select lease6_select
 
  - @b Arguments:
-- 
2.47.3