Browse Source

[5111] Updated dhcp4/6 developer's hook point doc

    src/bin/dhcp4/dhcp4_hooks.dox
    src/bin/dhcp6/dhcp6_hooks.dox
        replace "control-command-received" with
        "command-processed"
Thomas Markwalder 7 years ago
parent
commit
8e32fdd8d3
2 changed files with 25 additions and 57 deletions
  1. 11 27
      src/bin/dhcp4/dhcp4_hooks.dox
  2. 14 30
      src/bin/dhcp6/dhcp6_hooks.dox

+ 11 - 27
src/bin/dhcp4/dhcp4_hooks.dox

@@ -308,38 +308,22 @@ to the end of this list.
   expired leases will remain in the database and their recovery will
   expired leases will remain in the database and their recovery will
   be attempted during the next reclaim cycle.
   be attempted during the next reclaim cycle.
 
 
-@subsection dhcpv4HooksControlCommandReceive control_command_receive
+@subsection dhcpv4HooksCommandProcessed command_processed
 
 
  - @b Arguments:
  - @b Arguments:
-   - name: @b command, type: isc::data::ConstElementPtr, direction: <b>in/out</b>
+   - name: @b name, type: std::string, direction: <b>in</b>
+   - name: @b arguments type: isc::data::ConstElementPtr, direction: <b>in</b>
    - name: @b response, type: isc::data::ConstElementPtr, direction: <b>in/out</b>
    - name: @b response, type: isc::data::ConstElementPtr, direction: <b>in/out</b>
 
 
- - @b Description: this callout is executed when DHCPv4 server receives a
-   control command over the command channel (typically unix domain socket).
-   The "command" argument is a pointer to the parsed JSON structure
-   including command name and command arguments. If the callout implements
-   the specified command, it handles the command and creates appropriate
-   response. The response should be returned in the "response" argument.
-   In most cases, the callout which handles the command will set the next
-   step action to SKIP, to prevent the server from trying to handle the
-   command on its own and overriding the response created by the callouts.
-   A notable exception is the 'list-commands' command for which the callouts
-   should not set the next step action to SKIP. The server has a special
-   code path for this command which combines the list of commands returned
-   by the callouts with the list of commands supported by the server. If
-   the callout sets the next step action to SKIP in this case, the server
-   will only return the list of commands supported by the hook library.
-   The callout can modify the command arguments to influence the command
-   processing by the Command Manager. For example, it may freely modify
-   the configuration received in 'config-set' before it is processed by
-   the server. The SKIP action is not set in this case.
-
- - <b>Next step status</b>: if any callout sets the next step action to SKIP,
-   the server will assume that the command has been handled by the callouts
-   and will expect that the response is provided in the "response" argument.
-   The server will not handle the command in this case but simply return the
-   response returned by the callout to the caller.
+ - @b Description: this callout is executed after the DHCPv4 server receives
+   and processes a control command over the command channel (typically unix domain socket).
+   The "name" argument is the name of the command processed.
+   The "arguments" argument is a pointer to the parsed JSON structure
+   containing the command's input arguments.  The "response" argument
+   is the parsed JSON stucture containing the response generated by
+   the command processing.
 
 
+ - <b>Next step status</b>: Not applicable, it's value will be ignored.
 
 
 @section dhcpv4HooksOptionsAccess Accessing DHCPv4 Options within a Packet
 @section dhcpv4HooksOptionsAccess Accessing DHCPv4 Options within a Packet
 When the server constructs a response message to a client it includes
 When the server constructs a response message to a client it includes

+ 14 - 30
src/bin/dhcp6/dhcp6_hooks.dox

@@ -350,38 +350,22 @@ to the end of this list.
   expired leases will remain in the database and their recovery will
   expired leases will remain in the database and their recovery will
   be attempted during the next reclaim cycle.
   be attempted during the next reclaim cycle.
 
 
-@subsection dhcpv6HooksControlCommandReceive control_command_receive
+@subsection dhcpv6HooksCommandProcessed command_processed
 
 
  - @b Arguments:
  - @b Arguments:
-   - name: @b command, type: ConstElementPtr, direction: <b>in/out</b>
-   - name: @b response, type: ConstElementPtr, direction: <b>in/out</b>
-
- - @b Description: this callout is executed when DHCPv4 server receives a
-   control command over the command channel (typically unix domain socket).
-   The "command" argument is a pointer to the parsed JSON structure
-   including command name and command arguments. If the callout implements
-   the specified command, it handles the command and creates appropriate
-   response. The response should be returned in the "response" argument.
-   In most cases, the callout which handles the command will set the next
-   step action to SKIP, to prevent the server from trying to handle the
-   command on its own and overriding the response created by the callouts.
-   A notable exception is the 'list-commands' command for which the callouts
-   should not set the next step action to SKIP. The server has a special
-   code path for this command which combines the list of commands returned
-   by the callouts with the list of commands supported by the server. If
-   the callout sets the next step action to SKIP in this case, the server
-   will only return the list of commands supported by the hook library.
-   The callout can modify the command arguments to influence the command
-   processing by the Command Manager. For example, it may freely modify
-   the configuration received in 'config-set' before it is processed by
-   the server. The SKIP action is not set in this case.
-
- - <b>Next step status</b>: if any callout sets the next step action to SKIP,
-   the server will assume that the command has been handled by the callouts
-   and will expect that the response is provided in the "response" argument.
-   The server will not handle the command in this case but simply return the
-   response returned by the callout to the caller.
-
+   - name: @b name, type: std::string, direction: <b>in</b>
+   - name: @b arguments type: isc::data::ConstElementPtr, direction: <b>in</b>
+   - name: @b response, type: isc::data::ConstElementPtr, direction: <b>in/out</b>
+
+ - @b Description: this callout is executed after the DHCPv6 server receives
+   and processes a control command over the command channel (typically unix domain socket).
+   The "name" argument is the name of the command processed.
+   The "arguments" argument is a pointer to the parsed JSON structure
+   containing the command's input arguments.  The "response" argument
+   is the parsed JSON stucture containing the response generated by
+   the command processing.
+
+ - <b>Next step status</b>: Not applicable, it's value will be ignored.
 
 
 @section dhcpv6HooksOptionsAccess Accessing DHCPv6 Options within a Packet
 @section dhcpv6HooksOptionsAccess Accessing DHCPv6 Options within a Packet
 When the server constructs a response message to a client it includes
 When the server constructs a response message to a client it includes