STAR-1269: Refactor getActiveClients to return a copy of mClientList

Also added a new function to get a vector of just the sockets for
all the active clients.

Author: Per Moberg

SRTNet.cpp

@@ -347,10 +347,22 @@ bool SRTNet::waitForSRTClient(bool singleClient) {
     return false;
 }
 
-void SRTNet::getActiveClients(
-    const std::function<void(std::map<SRTSOCKET, std::shared_ptr<NetworkConnection>>&)>& function) {
+std::vector<std::pair<SRTSOCKET, std::shared_ptr<SRTNet::NetworkConnection>>> SRTNet::getActiveClients() const {
     std::lock_guard<std::mutex> lock(mClientListMtx);
-    function(mClientList);
+
+    std::vector<std::pair<SRTSOCKET, std::shared_ptr<NetworkConnection>>> clients;
+    std::copy(mClientList.begin(), mClientList.end(), std::back_inserter(clients));
+    return clients;
+}
+
+std::vector<SRTSOCKET> SRTNet::getActiveClientSockets() const {
+    std::lock_guard<std::mutex> lock(mClientListMtx);
+
+    std::vector<SRTSOCKET> clientSockets(mClientList.size());
+    for (const auto& [socket, networkConnection] : mClientList) {
+        clientSockets.push_back(socket);
+    }
+    return clientSockets;
 }
 
 bool SRTNet::startClient(const std::string& host,

SRTNet.h

@@ -205,13 +205,19 @@ class SRTNet {
 
     /**
      *
-     * Get active clients (A server method)
+     * @brief Get all active clients (A server method)
+     * @return A vector of pairs containing the SRTSocketHandle (SRTSOCKET) and it's associated NetworkConnection you provided.
      *
-     * @param function. pass a function getting the map containing the list of active connections
-     * Where the map contains the SRTSocketHandle (SRTSOCKET) and it's associated NetworkConnection you provided.
      */
-    void
-    getActiveClients(const std::function<void(std::map<SRTSOCKET, std::shared_ptr<NetworkConnection>>&)>& function);
+    std::vector<std::pair<SRTSOCKET, std::shared_ptr<NetworkConnection>>> getActiveClients() const;
+
+    /**
+     *
+     * @brief Get the socket of all active clients (A server method)
+     * @return A vector containing the SRTSocketHandle (SRTSOCKET) of all active clients.
+     *
+     */
+    std::vector<SRTSOCKET> getActiveClientSockets() const;
 
     /**
      *
@@ -428,7 +434,7 @@ class SRTNet {
     mutable std::mutex mNetMtx;
     Mode mCurrentMode = Mode::unknown;
     std::map<SRTSOCKET, std::shared_ptr<NetworkConnection>> mClientList = {};
-    std::mutex mClientListMtx;
+    mutable std::mutex mClientListMtx;
     std::shared_ptr<NetworkConnection> mClientContext = nullptr;
     std::shared_ptr<NetworkConnection> mConnectionContext = nullptr;
     std::atomic<bool> mClientConnected = false;

main.cpp

@@ -217,10 +217,8 @@ int main(int argc, const char *argv[]) {
     //  std::cout << "The server got " << clients->mClientList->size() << " clients." << std::endl;
     //  clients = nullptr;
 
-    gSRTNetServer.getActiveClients([](std::map<SRTSOCKET, std::shared_ptr<SRTNet::NetworkConnection>> &clientList) {
-                                       std::cout << "The server got " << clientList.size() << " client(s)." << std::endl;
-                                   }
-    );
+    auto clientList = gSRTNetServer.getActiveClientSockets();
+    std::cout << "The server got " << clientList.size() << " client(s)." << std::endl;
 
     //Send 300 packets with 10 milliseconds spacing. Packets are 1000 bytes long
     int lTimes = 0;
@@ -272,10 +270,9 @@ int main(int argc, const char *argv[]) {
     //SRT_TRACEBSTATS lCurrentServerStats = {0};
     //mySRTNetServer.getStatistics(&currentServerStats,SRTNetClearStats::yes,SRTNetInstant::no);
 
-    gSRTNetServer.getActiveClients([](std::map<SRTSOCKET, std::shared_ptr<SRTNet::NetworkConnection>> &rClientList) {
-                                       std::cout << "The server got " << rClientList.size() << " clients." << std::endl;
-                                   }
-    );
+    clientList = gSRTNetServer.getActiveClientSockets();
+    std::cout << "The server got " << clientList.size() << " client(s)." << std::endl;
+
 
     std::cout << "SRT garbage collect" << std::endl;
     gSRTNetServer.stop();
@@ -285,10 +282,8 @@ int main(int argc, const char *argv[]) {
     std::cout << "stopClient 2" << std::endl;
     gSRTNetClient2.stop();
 
-    gSRTNetServer.getActiveClients([](std::map<SRTSOCKET, std::shared_ptr<SRTNet::NetworkConnection>> &clientList) {
-                                       std::cout << "The server got " << clientList.size() << " clients." << std::endl;
-                                   }
-    );
+    clientList = gSRTNetServer.getActiveClientSockets();
+    std::cout << "The server got " << clientList.size() << " client(s)." << std::endl;
 
     srt_cleanup();
     std::cout << "SRT wrapper did end." << std::endl;