]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[5530a] Documentation for dhcp6_srv_configured added.
authorTomek Mrugalski <tomasz@isc.org>
Wed, 25 Apr 2018 00:59:39 +0000 (01:59 +0100)
committerTomek Mrugalski <tomasz@isc.org>
Wed, 25 Apr 2018 00:59:39 +0000 (01:59 +0100)
src/bin/dhcp6/dhcp6_hooks.dox

index 45afd6cb38b8ace4e9f879efe097b187dd8b083e..1fd6e49413107abe4d9dfe21355cd6624e34488e 100644 (file)
@@ -46,6 +46,23 @@ packet processing, but the exact order depends on the actual processing. Hook po
 that are not specific to packet processing (e.g. lease expiration) will be added
 to the end of this list.
 
+ @subsection dhcp6HooksDhcpv4SrvConfigured dhcp6_srv_configured
+ - @b Arguments:
+   - name: @b io_context, type: isc::asiolink::IOServicePtr, direction: <b>in</b>
+   - name: @b json_config, type: isc::data::ConstElementPtr, direction: <b>in</b>
+   - name: @b server_config, type: isc::dhcp::SrvConfigPtr, direction: <b>in</b>
+
+ - @b Description: this callout is executed when the server has completed
+   its (re)configuration. The server provides received and parsed configuration
+   structures to the hook library. It also provides a pointer to the IOService
+   object which is used by the server to run asynchronous operations. The hooks
+   libraries can use this IOService object to schedule asynchronous tasks which
+   are triggered by the DHCP server's main loop. The hook library should hold the
+   provided pointer until the library is unloaded.
+
+ - <b>Next step status</b>: Status codes retured by the callouts installed on
+   this hook point are ignored.
+
  @subsection dhcpv6HooksBuffer6Receive buffer6_receive
 
  - @b Arguments: