Changeset 79530 in vbox for trunk/src

Timestamp:

Jul 4, 2019 6:25:04 PM (6 years ago)

Author:

vboxsync

Message:

Dhcpd: Went over the Db and IPv4Pool code adding comments and and such. [doxygen+scm] bugref:9288

Location:

trunk/src/VBox/NetworkServices/Dhcpd

Files:

• Db.cpp (modified) (10 diffs)
• Db.h (modified) (2 diffs)
• DhcpdInternal.h (modified) (2 diffs)
• Timestamp.h (modified) (2 diffs)

trunk/src/VBox/NetworkServices/Dhcpd/Db.cpp

@@ -369 +369 @@
  * @param   id          The client ID.
  */
-Binding *Db::createBinding(const ClientId &id)
+Binding *Db::i_createBinding(const ClientId &id)
 {
     Binding      *pBinding = NULL;
@@ -400 +400 @@
  * @param   id          The client.
  */
-Binding *Db::createBinding(RTNETADDRIPV4 addr, const ClientId &id)
+Binding *Db::i_createBinding(RTNETADDRIPV4 addr, const ClientId &id)
 {
     bool fAvailable = m_pool.allocate(addr);
@@ -423 +423 @@
  * the preferred address (@a addr) into account when possible and if non-zero.
  */
-Binding *Db::allocateAddress(const ClientId &id, RTNETADDRIPV4 addr)
+Binding *Db::i_allocateAddress(const ClientId &id, RTNETADDRIPV4 addr)
 {
     Assert(addr.u == 0 || addressBelongs(addr));
@@ -503 +503 @@
         if (addrBinding == NULL)
         {
-            addrBinding = createBinding(addr, id);
+            addrBinding = i_createBinding(addr, id);
             Assert(addrBinding != NULL);
             LogDHCP(("> .... creating new binding for this address %R[binding]\n", addrBinding));
@@ -529 +529 @@
     else
     {
-        idBinding = createBinding();
+        idBinding = i_createBinding();
         if (idBinding != NULL)
             LogDHCP(("> .... creating new binding\n"));
@@ -586 +586 @@
     const ClientId &id(req.clientId());
 
-    Binding *b = allocateAddress(id, reqAddr.value());
+    Binding *b = i_allocateAddress(id, reqAddr.value());
     if (b != NULL)
     {
@@ -607 +607 @@
  *
  * @returns IPRT status code.
- * @param   newb                .
- */
-int Db::addBinding(Binding *pNewBinding)
+ * @param   pNewBinding     The new binding to add.
+ */
+int Db::i_addBinding(Binding *pNewBinding)
 {
     /*
@@ -841 +841 @@
         if (pElmLease->nameEquals("Lease"))
         {
-            int rc2 = loadLease(pElmLease);
+            int rc2 = i_loadLease(pElmLease);
             if (RT_SUCCESS(rc2))
             { /* likely */ }
@@ -863 +863 @@
  * @return  IPRT status code.
  */
-int Db::loadLease(const xml::ElementNode *pElmLease)
+int Db::i_loadLease(const xml::ElementNode *pElmLease)
 {
     Binding *pBinding = NULL;
@@ -882 +882 @@
             LogDHCP(("> LOAD: EXPIRED lease %R[binding]\n", pBinding));
 
-        int rc = addBinding(pBinding);
+        int rc = i_addBinding(pBinding);
         if (RT_FAILURE(rc))
             delete pBinding;

trunk/src/VBox/NetworkServices/Dhcpd/Db.h

@@ -163 +163 @@
     int      loadLeases(const RTCString &strFilename);
 private:
-    int      loadLease(const xml::ElementNode *pElmLease);
+    int      i_loadLease(const xml::ElementNode *pElmLease);
 public:
     int      writeLeases(const RTCString &strFilename) const;
@@ -169 +169 @@
 
 private:
-    Binding *createBinding(const ClientId &id = ClientId());
-    Binding *createBinding(RTNETADDRIPV4 addr, const ClientId &id = ClientId());
+    Binding *i_createBinding(const ClientId &id = ClientId());
+    Binding *i_createBinding(RTNETADDRIPV4 addr, const ClientId &id = ClientId());
 
-    Binding *allocateAddress(const ClientId &id, RTNETADDRIPV4 addr);
+    Binding *i_allocateAddress(const ClientId &id, RTNETADDRIPV4 addr);
 
     /* add binding e.g. from the leases file */
-    int      addBinding(Binding *b);
+    int      i_addBinding(Binding *pNewBinding);
 };
 

trunk/src/VBox/NetworkServices/Dhcpd/DhcpdInternal.h

@@ -16 +16 @@
  */
 
-#ifndef VBOX_INCLUDED_SRC_Dhcpd_Defs_h
-#define VBOX_INCLUDED_SRC_Dhcpd_Defs_h
+#ifndef VBOX_INCLUDED_SRC_Dhcpd_DhcpdInternal_h
+#define VBOX_INCLUDED_SRC_Dhcpd_DhcpdInternal_h
 #ifndef RT_WITHOUT_PRAGMA_ONCE
 # pragma once
@@ -72 +72 @@
 #endif
 
-#endif /* !VBOX_INCLUDED_SRC_Dhcpd_Defs_h */
+#endif /* !VBOX_INCLUDED_SRC_Dhcpd_DhcpdInternal_h */

trunk/src/VBox/NetworkServices/Dhcpd/Timestamp.h

@@ -16 +16 @@
  */
 
-#ifndef VBOX_INCLUDED_SRC_Dhcpd_TimeStamp_h
-#define VBOX_INCLUDED_SRC_Dhcpd_TimeStamp_h
+#ifndef VBOX_INCLUDED_SRC_Dhcpd_Timestamp_h
+#define VBOX_INCLUDED_SRC_Dhcpd_Timestamp_h
 #ifndef RT_WITHOUT_PRAGMA_ONCE
 # pragma once
@@ -110 +110 @@
 inline bool operator>=(const Timestamp &l, const Timestamp &r) { return l.compare(r) >= 0; }
 
-#endif /* !VBOX_INCLUDED_SRC_Dhcpd_TimeStamp_h */
+#endif /* !VBOX_INCLUDED_SRC_Dhcpd_Timestamp_h */