]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3178] Added missing comments to ha_impl.h
authorMarcin Siodelski <marcin@isc.org>
Fri, 5 Jan 2024 14:43:34 +0000 (15:43 +0100)
committerMarcin Siodelski <marcin@isc.org>
Fri, 5 Jan 2024 18:04:19 +0000 (19:04 +0100)
src/hooks/dhcp/high_availability/ha_impl.h

index fcf398309af61a1f3ffb61e77d739af81d7d8c3b..5339bc9f029b32ae02eb86a5c9f8976e63bcc65a 100644 (file)
@@ -102,6 +102,12 @@ public:
     void buffer4Receive(hooks::CalloutHandle& callout_handle);
 
     /// @brief Implementation of the "subnet4_select" callout.
+    ///
+    /// This callout decides whether the received packet should be processed
+    /// by the server when the server has multiple HA relationships. The
+    /// relationship selection is based on the selected subnet.
+    ///
+    /// @param callout_handle Callout handle provided to the callout.
     void subnet4Select(hooks::CalloutHandle& callout_handle);
 
     /// @brief Implementation of the "leases4_committed" callout.
@@ -137,6 +143,12 @@ public:
 
 
     /// @brief Implementation of the "subnet6_select" callout.
+    ///
+    /// This callout decides whether the received packet should be processed
+    /// by the server when the server has multiple HA relationships. The
+    /// relationship selection is based on the selected subnet.
+    ///
+    /// @param callout_handle Callout handle provided to the callout.
     void subnet6Select(hooks::CalloutHandle& callout_handle);
 
     /// @brief Implementation of the "leases6_committed" callout.