Parcourir la source

[5132] Developer's guide update for new hooks

Tomek Mrugalski il y a 8 ans
Parent
commit
925cd4592b
2 fichiers modifiés avec 32 ajouts et 0 suppressions
  1. 16 0
      src/bin/dhcp4/dhcp4_hooks.dox
  2. 16 0
      src/bin/dhcp6/dhcp6_hooks.dox

+ 16 - 0
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.
    sets the next step status to SKIP, the server will not select any subnet.
    Packet processing will continue, but will be severely limited.
    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
 @subsection dhcpv4HooksLeaseSelect lease4_select
 
 
  - @b Arguments:
  - @b Arguments:

+ 16 - 0
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
    sets the status to SKIP, the server will not select any subnet. Packet processing
    will continue, but will be severely limited.
    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
 @subsection dhcpv6HooksLease6Select lease6_select
 
 
  - @b Arguments:
  - @b Arguments: