Refactor CServer::CreateAndSendChatTextForAllConChannels to remove duplicate code. Split reusable code into functions

Author: dingodoppelt

docs/JSON-RPC.md

@@ -657,7 +657,7 @@ Parameters:
 
 ### jamulusserver/chatMessageReceived
 
-Emitted when a chat message is received.
+Emitted when a chat message is received from either a Jamulus or RPC client and to be broadcast to all connected clients.
 
 Parameters:
 

src/server.cpp

@@ -1300,32 +1300,27 @@ void CServer::CreateAndSendChatTextForAllConChannels ( const int iCurChanID, con
 
     const QString strActualMessageText = "<font color=\"" + sCurColor + "\">(" + QTime::currentTime().toString ( "hh:mm:ss AP" ) + ") <b>" +
                                          ChanName.toHtmlEscaped() + "</b></font> " + strChatText.toHtmlEscaped();
+    SendChatTextToAllChannels ( strActualMessageText );
+}
 
-    // Send chat text to all connected clients ---------------------------------
+void CServer::SendChatTextToAllChannels ( const QString& strChatText )
+{
+    // Send chat text to all channels -------------------------------------------
     for ( int i = 0; i < iMaxNumChannels; i++ )
     {
-        if ( vecChannels[i].IsConnected() )
-        {
-            // send message
-            vecChannels[i].CreateChatTextMes ( strActualMessageText );
-        }
+        SendChatTextToConChannel ( i, strChatText );
     }
-    emit receivedChatMessage ( strActualMessageText );
+    emit sentChatMessage ( strChatText );
 }
 
-// external chat
-void CServer::CreateAndSendExtChatTextForAllConChannels ( const QString& strChatText )
+void CServer::SendChatTextToConChannel ( const int iCurChanID, const QString& strChatText )
 {
-    // Send chat text to all connected clients ---------------------------------
-    for ( int i = 0; i < iMaxNumChannels; i++ )
+    // Only send chat text if channel is connected ------------------------------
+    if ( vecChannels[iCurChanID].IsConnected() )
     {
-        if ( vecChannels[i].IsConnected() )
-        {
-            // send message
-            vecChannels[i].CreateChatTextMes ( strChatText );
-        }
+        // send message
+        vecChannels[iCurChanID].CreateChatTextMes ( strChatText );
     }
-    emit receivedChatMessage ( strChatText );
 }
 
 void CServer::CreateAndSendRecorderStateForAllConChannels()

src/server.h

@@ -191,7 +191,7 @@ class CServer : public QObject, public CServerSlots<MAX_NUM_CHANNELS>
     void SetEnableDelayPanning ( bool bDelayPanningOn ) { bDelayPan = bDelayPanningOn; }
     bool IsDelayPanningEnabled() { return bDelayPan; }
 
-    void CreateAndSendExtChatTextForAllConChannels ( const QString& strChatText );
+    void SendChatTextToAllChannels ( const QString& strChatText );
 
 protected:
     // access functions for actual channels
@@ -207,6 +207,7 @@ class CServer : public QObject, public CServerSlots<MAX_NUM_CHANNELS>
     virtual void CreateAndSendChanListForThisChan ( const int iCurChanID );
 
     virtual void CreateAndSendChatTextForAllConChannels ( const int iCurChanID, const QString& strChatText );
+    void         SendChatTextToConChannel ( const int iCurChanID, const QString& strChatText );
 
     virtual void CreateOtherMuteStateChanged ( const int iCurChanID, const int iOtherChanID, const bool bIsMuted );
 
@@ -332,7 +333,7 @@ class CServer : public QObject, public CServerSlots<MAX_NUM_CHANNELS>
     void ClientDisconnected ( const int iChID );
     void ClientDisconnectedRPC ( const int iChID );
     void ClientConnected ( const int iChID, const QHostAddress RecHostAddr, const int iTotChans );
-    void receivedChatMessage ( const QString& strChatText );
+    void sentChatMessage ( const QString& strChatText );
     void SvrRegStatusChanged();
     void AudioFrame ( const int              iChID,
                       const QString          stChName,

src/serverrpc.cpp

@@ -86,9 +86,9 @@ CServerRpc::CServerRpc ( CServer* pServer, CRpcServer* pRpcServer, QObject* pare
         Qt::QueuedConnection );
 
     /// @rpc_notification jamulusserver/chatMessageReceived
-    /// @brief Emitted when a chat message is received.
+    /// @brief Emitted when a chat message is received from either a Jamulus or RPC client and to be broadcast to all connected clients.
     /// @param {string} params.chatMessage - Chat message text.
-    connect ( pServer, &CServer::receivedChatMessage, [=] ( const QString& strChatText ) {
+    connect ( pServer, &CServer::sentChatMessage, [=] ( const QString& strChatText ) {
         pRpcServer->BroadcastNotification ( "jamulusserver/chatMessageReceived",
                                             QJsonObject{
                                                 { "chatMessage", strChatText },
@@ -107,7 +107,7 @@ CServerRpc::CServerRpc ( CServer* pServer, CRpcServer* pRpcServer, QObject* pare
             return;
         }
 
-        pServer->CreateAndSendExtChatTextForAllConChannels ( jsonChatMessage.toString() );
+        pServer->SendChatTextToAllChannels ( jsonChatMessage.toString() );
         response["result"] = "ok";
     } );