Browse Source

[2994] DHCPv4 Hooks documentation written.

Tomek Mrugalski 11 years ago
parent
commit
2cbcb533f7
4 changed files with 17 additions and 2 deletions
  1. 5 0
      doc/devel/mainpage.dox
  2. 4 0
      src/bin/dhcp4/dhcp4.dox
  3. 4 0
      src/bin/dhcp6/dhcp6.dox
  4. 4 2
      src/bin/dhcp6/dhcp6_hooks.dox

+ 5 - 0
doc/devel/mainpage.dox

@@ -37,6 +37,8 @@
  * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
  * @section hooksFramework Hooks Framework
  * - @subpage hooksComponentDeveloperGuide
+ * - @subpage dhcpv4Hooks
+ * - @subpage dhcpv6Hooks
  *
  * @section dnsMaintenanceGuide DNS Maintenance Guide
  * - Authoritative DNS (todo)
@@ -48,10 +50,13 @@
  *   - @subpage dhcpv4Session
  *   - @subpage dhcpv4ConfigParser
  *   - @subpage dhcpv4ConfigInherit
+ *   - @subpage dhcpv4Other
+ *   - @subpage dhcpv4Hooks
  * - @subpage dhcp6
  *   - @subpage dhcpv6Session
  *   - @subpage dhcpv6ConfigParser
  *   - @subpage dhcpv6ConfigInherit
+ *   - @subpage dhcpv6Other
  *   - @subpage dhcpv6Hooks
  * - @subpage libdhcp
  *   - @subpage libdhcpIntro

+ 4 - 0
src/bin/dhcp4/dhcp4.dox

@@ -79,4 +79,8 @@ See \ref dhcpv6ConfigParser.
 Configuration inheritance in DHCPv4 follows exactly the same logic as its DHCPv6
 counterpart. See \ref dhcpv6ConfigInherit.
 
+@section dhcpv4Other Other DHCPv4 topics
+
+ For hooks API support in DHCPv4, see @ref dhcpv4Hooks.
+
 */

+ 4 - 0
src/bin/dhcp6/dhcp6.dox

@@ -92,4 +92,8 @@
 
  @todo Add section about setting up options and their definitions with bindctl.
 
+ @section dhcpv6Other Other DHCPv6 topics
+
+ For hooks API support in DHCPv6, see @ref dhcpv6Hooks.
+
  */

+ 4 - 2
src/bin/dhcp6/dhcp6_hooks.dox

@@ -110,8 +110,10 @@ packet processing. Hook points that are not specific to packet processing
    means that the lease won't be inserted into the database (SOLICIT),
    a value of false means that it will (REQUEST).
 
- - <b>Skip flag action</b>: the "skip" flag is ignored by the server on this
-   hook.
+ - <b>Skip flag action</b>: If any callout installed on 'lease6_select'
+   sets the skip flag, the server will not assign that particular lease.
+   Packet processing will continue and the client may get other addresses
+   or prefixes if it requested more than one address and/or prefix.
 
 @subsection dhcpv6HooksPkt6Send pkt6_send