Refactor: Name GetDataMsg enum and replace ppszTypeName array for direct GetCommand call.

furszy · furszy · commit c398797a61f5 · 2021-07-21T17:28:26.000-03:00
The array is duplicated with the NetMsgType constants
diff --git a/src/protocol.cpp b/src/protocol.cpp
@@ -52,26 +52,6 @@ const char* SYNCSTATUSCOUNT = "ssc";
 const char* GETMNLIST = "dseg";
 }; // namespace NetMsgType
 
-static const char* ppszTypeName[] = {
-    "ERROR", // Should never occur
-    NetMsgType::TX,
-    NetMsgType::BLOCK,
-    "filtered block", // Should never occur
-    "ix",   // deprecated
-    "txlvote", // deprecated
-    NetMsgType::SPORK,
-    NetMsgType::MNWINNER,
-    "mnodescanerr",
-    NetMsgType::BUDGETVOTE,
-    NetMsgType::BUDGETPROPOSAL,
-    NetMsgType::FINALBUDGET,
-    NetMsgType::FINALBUDGETVOTE,
-    "mnq",
-    NetMsgType::MNBROADCAST,
-    NetMsgType::MNPING,
-    "dstx"  // deprecated
-};
-
 /** All known message types. Keep this in the same order as the list of
  * messages above and in protocol.h.
  */
@@ -207,25 +187,36 @@ bool operator<(const CInv& a, const CInv& b)
     return (a.type < b.type || (a.type == b.type && a.hash < b.hash));
 }
 
-bool CInv::IsKnownType() const
-{
-    return (type >= 1 && type < (int)ARRAYLEN(ppszTypeName));
-}
-
 bool CInv::IsMasterNodeType() const{
      return type > 2;
 }
 
-const char* CInv::GetCommand() const
+std::string CInv::GetCommand() const
 {
-    if (!IsKnownType()) {
-        LogPrint(BCLog::NET, "CInv::GetCommand() : type=%d unknown type", type);
-        return "UNKNOWN";
+    std::string cmd;
+    switch (type) {
+        case MSG_TX:                return cmd.append(NetMsgType::TX);
+        case MSG_BLOCK:             return cmd.append(NetMsgType::BLOCK);
+        case MSG_FILTERED_BLOCK:    return cmd.append(NetMsgType::MERKLEBLOCK);
+        case MSG_TXLOCK_REQUEST:    return cmd.append("ix");       // Deprecated
+        case MSG_TXLOCK_VOTE:       return cmd.append("txlvote");  // Deprecated
+        case MSG_SPORK:             return cmd.append(NetMsgType::SPORK);
+        case MSG_MASTERNODE_WINNER: return cmd.append(NetMsgType::MNWINNER);
+        case MSG_MASTERNODE_SCANNING_ERROR: return cmd.append("mnodescanerr"); // Deprecated
+        case MSG_BUDGET_VOTE: return cmd.append(NetMsgType::BUDGETVOTE);
+        case MSG_BUDGET_PROPOSAL: return cmd.append(NetMsgType::BUDGETPROPOSAL);
+        case MSG_BUDGET_FINALIZED: return cmd.append(NetMsgType::FINALBUDGET);
+        case MSG_BUDGET_FINALIZED_VOTE: return cmd.append(NetMsgType::FINALBUDGETVOTE);
+        case MSG_MASTERNODE_QUORUM: return cmd.append("mnq"); // Unused
+        case MSG_MASTERNODE_ANNOUNCE: return cmd.append(NetMsgType::MNBROADCAST);
+        case MSG_MASTERNODE_PING: return cmd.append(NetMsgType::MNPING);
+        case MSG_DSTX: return cmd.append("dstx"); // Deprecated
+        default:
+            throw std::out_of_range(strprintf("%s: type=%d unknown type", __func__, type));
     }
-
-    return ppszTypeName[type];
 }
 
+
 std::string CInv::ToString() const
 {
     return strprintf("%s %s", GetCommand(), hash.ToString());
diff --git a/src/protocol.h b/src/protocol.h
@@ -326,32 +326,11 @@ class CAddress : public CService
     unsigned int nTime;
 };
 
-/** inv message data */
-class CInv
+/** getdata message types */
+enum GetDataMsg
 {
-public:
-    CInv();
-    CInv(int typeIn, const uint256& hashIn);
-
-    SERIALIZE_METHODS(CInv, obj) { READWRITE(obj.type, obj.hash); }
-
-    friend bool operator<(const CInv& a, const CInv& b);
-
-    bool IsKnownType() const;
-    bool IsMasterNodeType() const;
-    std::string ToString() const;
-
-    // TODO: make private (improves encapsulation)
-public:
-    int type;
-    uint256 hash;
-
-private:
-    const char* GetCommand() const;
-};
-
-enum {
-    MSG_TX = 1,
+    UNDEFINED = 0,
+    MSG_TX,
     MSG_BLOCK,
     // Nodes may always request a MSG_FILTERED_BLOCK in a getdata, however,
     // MSG_FILTERED_BLOCK should not appear in any invs except as a part of getdata.
@@ -368,7 +347,29 @@ enum {
     MSG_MASTERNODE_QUORUM,
     MSG_MASTERNODE_ANNOUNCE,
     MSG_MASTERNODE_PING,
-    MSG_DSTX
+    MSG_DSTX,
+    MSG_TYPE_MAX = MSG_DSTX
+};
+
+/** inv message data */
+class CInv
+{
+public:
+    CInv();
+    CInv(int typeIn, const uint256& hashIn);
+
+    SERIALIZE_METHODS(CInv, obj) { READWRITE(obj.type, obj.hash); }
+
+    friend bool operator<(const CInv& a, const CInv& b);
+
+    bool IsMasterNodeType() const;
+    std::string GetCommand() const;
+    std::string ToString() const;
+
+    // TODO: make private (improve encapsulation)
+public:
+    int type;
+    uint256 hash;
 };
 
 #endif // BITCOIN_PROTOCOL_H
