From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 30 Nov 2015 12:12:05 +0000 (+0100)
Subject: Merge branch 'kea-fb2' of https://github.com./nchaigne/kea into pullreq8
X-Git-Tag: trac4231_base~30
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=28f32bb5f74dbb7c522040f6cb09e86ff76e9cfe;p=thirdparty%2Fkea.git

Merge branch 'kea-fb2' of https://github.com./nchaigne/kea into pullreq8

# Conflicts:
#	src/bin/dhcp4/dhcp4_hooks.dox
---

28f32bb5f74dbb7c522040f6cb09e86ff76e9cfe
diff --cc src/bin/dhcp4/dhcp4_hooks.dox
index 30d4beb312,e286a6d479..643b4735e0
--- a/src/bin/dhcp4/dhcp4_hooks.dox
+++ b/src/bin/dhcp4/dhcp4_hooks.dox
@@@ -204,22 -176,25 +204,26 @@@ packet processing. Hook points that ar
  
   - @b Arguments:
     - name: @b response4, type: isc::dhcp::Pkt4Ptr, direction: <b>in/out</b>
+    - name: @b query4, type: isc::dhcp::Pkt4Ptr, direction: <b>in</b>
  
   - @b Description: this callout is executed when server's response
 -   is about to be sent back to the client. The argument response4
 -   contains a pointer to an isc::dhcp::Pkt4 object that contains the
 +   is about to be sent back to the client. The sole argument "response4"
 +   contains a pointer to an isc::dhcp::Pkt4 object carrying the
     packet, with source and destination addresses set, interface over which
     it will be sent, and a list of all options and relay information.  All fields
 -   of the Pkt4 object can be modified at this time, except buffer_out_.
 +   of the @c Pkt4 object can be modified at this time, except @c buffer_out_.
     (This is scratch space used for constructing the packet after all
     pkt4_send callouts are complete, so any changes to that field will
-    be overwritten.)
+    be overwritten.)\n\n
+    The argument query4 contains a pointer to the corresponding query packet
+    (allowing to perform correlation between response and query). This object
+    cannot be modified.
  
 - - <b>Skip flag action</b>: if any callout sets the skip flag, the server
 -   will not construct raw buffer. The expectation is that if the callout
 -   set skip flag, it is responsible for constructing raw form on its own.
 -   Otherwise the output packet will be sent with zero length.
 + - <b>Next step action</b>: if any callout installed on the "pkt4_send" hook
 +   sets the next step action to SKIP, the server will not construct the raw
 +   buffer. The expectation is that if the callout set skip flag, it is
 +   responsible for constructing raw form on its own. Otherwise the output
 +   packet will be sent with zero length.
  
  @subsection dhcpv4HooksBuffer4Send buffer4_send