]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[5443] Changes after review (wordsmithing)
authorTomek Mrugalski <tomasz@isc.org>
Fri, 19 Jan 2018 14:21:19 +0000 (15:21 +0100)
committerTomek Mrugalski <tomasz@isc.org>
Fri, 19 Jan 2018 14:21:19 +0000 (15:21 +0100)
src/bin/dhcp4/dhcp4_hooks.dox
src/bin/dhcp4/dhcp4_messages.mes
src/bin/dhcp6/dhcp6_hooks.dox
src/bin/dhcp6/dhcp6_messages.mes

index c522453e6a83695e54743b8a721cfa3942aa1ffb..b9095995530d245b1583eaea7726edd7ffe21ad4 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2013-2017 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2013-2018 Internet Systems Consortium, Inc. ("ISC")
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -87,7 +87,7 @@ to the end of this list.
    field has been already parsed and stored in other fields. Therefore,
    the modification in the data_ field has no effect.
 
- - <b>Next step status</b>: If any callout sets the status to SKIP (or DROP), the server will
+ - <b>Next step status</b>: If any callout sets the status to SKIP or DROP, the server will
    drop the packet and start processing the next one.  The reason for the drop
    will be logged if logging is set to the appropriate debug level.
 
@@ -188,7 +188,7 @@ to the end of this list.
    be released. It doesn't make sense to modify it at this time.
 
  - <b>Next step status</b>: If any callout installed on the "lease4_release" hook
-   sets the next step action to SKIP (or DROP), the server will not delete the lease.
+   sets the next step action to SKIP or DROP, the server will not delete the lease.
    It will be kept in the database and will go through the regular expiration/reuse
    process.
 
@@ -209,7 +209,7 @@ to the end of this list.
    before it is updated in the database.
 
  - <b>Next step status</b>: If any callout installed on the "lease4_decline" hook
-   sets the next step action to SKIP (or DROP), the server will not decline the lease.
+   sets the next step action to SKIP or DROP, the server will not decline the lease.
    Care should be taken when setting this status.  The lease will be kept in
    the database as it is and the client will incorrectly assume that the server
    marked this lease as unavailable. If the client restarts its configuration,
@@ -235,7 +235,7 @@ to the end of this list.
    cannot be modified.
 
  - <b>Next step action</b>: if any callout installed on the "pkt4_send" hook
-   sets the next step action to SKIP (or DROP), the server will not construct the raw
+   sets the next step action to SKIP or DROP, 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.
@@ -256,7 +256,7 @@ to the end of this list.
    time, because they were already used to construct on-wire buffer. Their
    modification would have no effect.
 
- - <b>Next step status</b>: if any callout sets the next step action to SKIP (or DROP),
+ - <b>Next step status</b>: if any callout sets the next step action to SKIP or DROP,
    the server will drop this response packet. However, the original request
    packet from a client was processed, so server's state most likely has changed
    (e.g. lease was allocated). Setting this flag merely stops the change
index ce08958ecf555828d1c7669dd68dc75e3ef5d881..6557c97098076ec249f40b0fe69233016b932ec9 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2017 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2012-2018 Internet Systems Consortium, Inc. ("ISC")
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -245,18 +245,18 @@ setting of the flag by a callout instructs the server to drop the packet.
 The arguments specify the source and destination IPv4 address as well as
 the name of the interface over which the buffer has been received.
 
-% DHCP4_HOOK_BUFFER_RCVD_SKIP received buffer from %1 to %2 over interface %3 is not parsed because a callout set the skip flag
+% DHCP4_HOOK_BUFFER_RCVD_SKIP received buffer from %1 to %2 over interface %3 is not parsed because a callout set the next step to SKIP.
 This debug message is printed when a callout installed on
-buffer4_receive hook point set the skip flag. For this particular hook
-point, the setting of the flag by a callout instructs the server to
+buffer4_receive hook point set the next step to SKIP. For this particular hook
+point, this value set by a callout instructs the server to
 not parse the buffer because it was already parsed by the hook. The
 arguments specify the source and destination IPv4 address as well as
 the name of the interface over which the buffer has been received.
 
-% DHCP4_HOOK_BUFFER_SEND_SKIP %1: prepared response is dropped because a callout set the skip flag.
+% DHCP4_HOOK_BUFFER_SEND_SKIP %1: prepared response is dropped because a callout set the next step to SKIP.
 This debug message is printed when a callout installed on buffer4_send
-hook point set the skip flag. For this particular hook point, the
-setting of the flag by a callout instructs the server to drop the packet.
+hook point set the next step to SKIP. For this particular hook point, the
+SKIP value set by a callout instructs the server to drop the packet.
 Server completed all the processing (e.g. may have assigned, updated
 or released leases), but the response will not be send to the client.
 
@@ -267,34 +267,33 @@ for decline4 hook point and one of the callouts set next step status to DROP.
 The server will now abort processing of the packet as if it was never
 received. The lease will continue to be assigned to this client.
 
-% DHCP4_HOOK_LEASE4_RELEASE_SKIP %1: lease was not released because a callout set the skip flag.
+% DHCP4_HOOK_LEASE4_RELEASE_SKIP %1: lease was not released because a callout set the next step to SKIP
 This debug message is printed when a callout installed on lease4_release
-hook point set the skip flag. For this particular hook point, the
-setting of the flag by a callout instructs the server to not release
-a lease.
+hook point set the next step status to SKIP. For this particular hook point, the
+value set by a callout instructs the server to not release a lease.
 
-% DHCP4_HOOK_PACKET_RCVD_SKIP %1: packet is dropped, because a callout set the skip flag.
+% DHCP4_HOOK_PACKET_RCVD_SKIP %1: packet is dropped, because a callout set the next step to SKIP
 This debug message is printed when a callout installed on the pkt4_receive
-hook point sets the skip flag. For this particular hook point, the
-setting of the flag instructs the server to drop the packet.
+hook point sets the next step to SKIP. For this particular hook point, the
+value setting of the flag instructs the server to drop the packet.
 
-% DHCP4_HOOK_PACKET_SEND_SKIP %1: prepared response is not sent, because a callout set skip flag.
+% DHCP4_HOOK_PACKET_SEND_SKIP %1: prepared response is not sent, because a callout set the next stp to SKIP
 This debug message is printed when a callout installed on the pkt4_send
-hook point sets the skip flag. For this particular hook point, the setting
-of the flag instructs the server to drop the packet. This means that
+hook point sets the next step to SKIP. For this particular hook point, this
+setting instructs the server to drop the packet. This means that
 the client will not get any response, even though the server processed
 client's request and acted on it (e.g. possibly allocated a lease).
 
-% DHCP4_HOOK_SUBNET4_SELECT_DROP %1: packet was dropped, because a callout set drop flag
+% DHCP4_HOOK_SUBNET4_SELECT_DROP %1: packet was dropped, because a callout set the next step to 'drop'
 This debug message is printed when a callout installed on the
-subnet4_select hook point sets the drop flag. For this particular hook
-point, the setting of the flag instructs the server to drop the received
+subnet4_select hook point sets the next step to 'drop' value. For this particular hook
+point, the setting to that value instructs the server to drop the received
 packet. The argument specifies the client and transaction identification
 information.
 
-% DHCP4_HOOK_SUBNET4_SELECT_SKIP %1: no subnet was selected, because a callout set skip flag.
+% DHCP4_HOOK_SUBNET4_SELECT_SKIP %1: no subnet was selected, because a callout set the next skip flag
 This debug message is printed when a callout installed on the
-subnet4_select hook point sets the skip flag. For this particular hook
+subnet4_select hook point sets the next step to SKIP value. For this particular hook
 point, the setting of the flag instructs the server not to choose a
 subnet, an action that severely limits further processing; the server
 will be only able to offer global options - no addresses will be assigned.
index abdd93bea4adf4a9c1e94033a2278f880f4a9dc5..45afd6cb38b8ace4e9f879efe097b187dd8b083e 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2013-2017 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2013-2018 Internet Systems Consortium, Inc. ("ISC")
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -91,7 +91,7 @@ to the end of this list.
    other fields in the Pkt6 object.  For this reason, modification of the
    @c data_ field would have no effect.)
 
- - <b>Next step status</b>: If any callout sets the status to SKIP (or DROP), the server will
+ - <b>Next step status</b>: If any callout sets the status to SKIP or DROP, the server will
    drop the packet and start processing the next one.  The reason for the drop
    will be logged if logging is set to the appropriate debug level.
 
@@ -262,7 +262,7 @@ to the end of this list.
    finish execution.
 
  - <b>Next step status</b>: If any callout installed on "lease6_release"
-   sets the status to SKIP (or DROP), the server will not delete the lease, which will
+   sets the status to SKIP or DROP, the server will not delete the lease, which will
    remain in the database until it expires. However, the server will send out
    the response back to the client as if it did.
 
@@ -306,7 +306,7 @@ to the end of this list.
    to modify that data, it will probably be found easier to modify the
    option objects in a callout attached to the "pkt6_send" hook).
 
- - <b>Next step status</b>: If any callout sets the status to SKIP (or DROP), the server
+ - <b>Next step status</b>: If any callout sets the status to SKIP or DROP, the server
    will drop this response packet. However, the original request packet
    from a client has been processed, so server's state has most likely changed
    (e.g. lease was allocated). Setting this flag merely stops the change
index 21f4444ffeeb51904ee2b04f9ae34ccb42af65f9..9130d958b1ba10e742c92917637ec155593aedc0 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2017 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2012-2018 Internet Systems Consortium, Inc. ("ISC")
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
@@ -253,24 +253,24 @@ setting of the flag by a callout instructs the server to drop the packet.
 The arguments specify the source and destination address as well as
 the name of the interface over which the buffer has been received.
 
-% DHCP6_HOOK_BUFFER_RCVD_SKIP received buffer from %1 to %2 over interface %3 is not parsed because a callout set the skip flag
+% DHCP6_HOOK_BUFFER_RCVD_SKIP received buffer from %1 to %2 over interface %3 is not parsed because a callout set the next step to SKIP
 This debug message is printed when a callout installed on
-buffer6_receive hook point set the skip flag. For this particular hook
-point, the setting of the flag by a callout instructs the server to
+buffer6_receive hook point set the next step status to skip. For this particular
+hook point, this value set by a callout instructs the server to
 not parse the buffer because it was already parsed by the hook. The
 arguments specify the source and destination address as well as the
 name of the interface over which the buffer has been received.
 
-% DHCP6_HOOK_BUFFER_SEND_SKIP %1: prepared DHCPv6 response was dropped because a callout set the skip flag
+% DHCP6_HOOK_BUFFER_SEND_SKIP %1: prepared DHCPv6 response was dropped because a callout set the next step to SKIP
 This debug message is printed when a callout installed on buffer6_send
-hook point set the skip flag. For this particular hook point, the
-setting of the flag by a callout instructs the server to drop the packet.
+hook point set the next step to SKIP value. For this particular hook point, the
+SKIP setting a callout instructs the server to drop the packet.
 Server completed all the processing (e.g. may have assigned, updated
 or released leases), but the response will not be send to the client.
 The argument includes the client and transaction identification
 information.
 
-% DHCP6_HOOK_DECLINE_DROP During Decline processing (client=%1, interface=%2, addr=%3) hook callout set status to DROP, dropping packet.
+% DHCP6_HOOK_DECLINE_DROP During Decline processing (client=%1, interface=%2, addr=%3) hook callout set next step to DROP, dropping packet.
 This message indicates that the server received DECLINE message, it was verified
 to be correct and matching server's lease information. The server called hooks
 for the lease6_decline hook point and one of the callouts set next step status to DROP.
@@ -285,50 +285,50 @@ The server will skip the operation of moving the lease to the declined state and
 will continue processing the packet. In particular, it will send a REPLY message
 as if the decline actually took place.
 
-% DHCP6_HOOK_LEASE6_RELEASE_NA_SKIP %1: DHCPv6 address lease was not released because a callout set the skip flag
+% DHCP6_HOOK_LEASE6_RELEASE_NA_SKIP %1: DHCPv6 address lease was not released because a callout set the next step to SKIP
 This debug message is printed when a callout installed on the
-lease6_release hook point set the skip flag. For this particular hook
-point, the setting of the flag by a callout instructs the server to not
+lease6_release hook point set the next step to SKIP. For this particular hook
+point, this setting by a callout instructs the server to not
 release a lease. If a client requested the release of multiples leases
 (by sending multiple IA options), the server will retain this particular
 lease and proceed with other releases as usual. The argument holds the
 client and transaction identification information.
 
-% DHCP6_HOOK_LEASE6_RELEASE_PD_SKIP %1: prefix lease was not released because a callout set the skip flag
+% DHCP6_HOOK_LEASE6_RELEASE_PD_SKIP %1: prefix lease was not released because a callout set the next step to SKIP
 This debug message is printed when a callout installed on lease6_release
-hook point set the skip flag. For this particular hook point, the
-setting of the flag by a callout instructs the server to not release
+hook point set the next step to SKIP value. For this particular hook point, that
+setting by a callout instructs the server to not release
 a lease. If client requested release of multiples leases (by sending
 multiple IA options), the server will retains this particular lease and
 will proceed with other renewals as usual. The argument holds the
 client and transaction identification information.
 
-% DHCP6_HOOK_PACKET_RCVD_SKIP %1: packet is dropped, because a callout set the skip flag.
+% DHCP6_HOOK_PACKET_RCVD_SKIP %1: packet is dropped, because a callout set the next step to SKIP
 This debug message is printed when a callout installed on the pkt6_receive
-hook point sets the skip flag. For this particular hook point, the
-setting of the flag instructs the server to drop the packet.
+hook point sets the next step to SKIP. For this particular hook point, the
+value setting instructs the server to drop the packet.
 
-% DHCP6_HOOK_PACKET_SEND_DROP %1: prepared DHCPv6 response was not sent because a callout set the drop flag
+% DHCP6_HOOK_PACKET_SEND_DROP %1: prepared DHCPv6 response was not sent because a callout set the next ste to DROP
 This debug message is printed when a callout installed on the pkt6_send
-hook point set the drop flag. For this particular hook point, the setting
-of the flag by a callout instructs the server to drop the packet. This
+hook point set the next step to DROP. For this particular hook point, the setting
+of the value by a callout instructs the server to drop the packet. This
 effectively means that the client will not get any response, even though
 the server processed client's request and acted on it (e.g. possibly
 allocated a lease). The argument specifies the client and transaction
 identification information.
 
-% DHCP6_HOOK_PACKET_SEND_SKIP %1: prepared DHCPv6 response is not built because a callout set the skip flag
+% DHCP6_HOOK_PACKET_SEND_SKIP %1: prepared DHCPv6 response is not built because a callout set the next step to SKIP
 This debug message is printed when a callout installed on the
-pkt6_send hook point set the skip flag. For this particular hook
-point, the setting of the flag by a callout instructs the server to
+pkt6_send hook point set the next step to SKIP. For this particular hook
+point, the setting of the value by a callout instructs the server to
 not build the wire data (pack) because it was already done by the
 book. The argument specifies the client and transaction identification
 information.
 
-% DHCP6_HOOK_SUBNET6_SELECT_SKIP %1: no subnet was selected because a callout set the skip flag
+% DHCP6_HOOK_SUBNET6_SELECT_SKIP %1: no subnet was selected because a callout set the next step to SKIP
 This debug message is printed when a callout installed on the
-subnet6_select hook point set the skip flag. For this particular hook
-point, the setting of the flag instructs the server not to choose a
+subnet6_select hook point set the next step to SKIP value. For this particular hook
+point, the setting of this value instructs the server not to choose a
 subnet, an action that severely limits further processing; the server
 will be only able to offer global options - no addresses or prefixes
 will be assigned. The argument holds the client and transaction