source/network/NetStats.h

   1 /* Copyright (C) 2023 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef INCLUDED_NETSTATS
  19 #define INCLUDED_NETSTATS
  20
  21 #include "ps/ProfileViewer.h"
  22
  23 #include <mutex>
  24 #include <vector>
  25
  26 typedef struct _ENetPeer ENetPeer;
  27 typedef struct _ENetHost ENetHost;
  28
  29 /**
  30  * ENet connection statistics profiler table.
  31  *
  32  * Thread-safety:
  33  * - Must be constructed in the main thread (to match the profiler).
  34  * - In host mode, the host can be running in a separate thread;
  35  *   call LatchHostState from that thread periodically to safely
  36  *   update our displayed copy of the data.
  37  */
  38 class CNetStatsTable : public AbstractProfileTable
  39 {
  40         NONCOPYABLE(CNetStatsTable);
  41 public:
  42         CNetStatsTable();
  43         CNetStatsTable(const ENetPeer* peer);
  44
  45         CStr GetName() override;
  46         CStr GetTitle() override;
  47         size_t GetNumberRows() override;
  48         const std::vector<ProfileColumn>& GetColumns() override;
  49         CStr GetCellText(size_t row, size_t col) override;
  50         AbstractProfileTable* GetChild(size_t row) override;
  51
  52         void LatchHostState(const ENetHost* host);
  53
  54 private:
  55         const ENetPeer* m_Peer;
  56         std::vector<ProfileColumn> m_ColumnDescriptions;
  57
  58         std::mutex m_Mutex;
  59         std::vector<std::vector<CStr>> m_LatchedData; // protected by m_Mutex
  60 };
  61
  62 #endif // INCLUDED_NETSTATS