Add message context parameter for CLM_TCP_SUPPORTED

Author: softins

src/client.h

@@ -477,7 +477,7 @@ protected slots:
 
     void CLRedServerListReceived ( CHostAddress InetAddr, CVector<CServerInfo> vecServerInfo );
 
-    void CLTcpSupported ( CHostAddress InetAddr );
+    void CLTcpSupported ( CHostAddress InetAddr, int iID );
 
     void CLConnClientsListMesReceived ( CHostAddress InetAddr, CVector<CChannelInfo> vecChanInfo );
 

src/clientdlg.h

@@ -223,7 +223,7 @@ public slots:
         ConnectDlg.SetServerList ( InetAddr, vecServerInfo, true );
     }
 
-    void OnCLTcpSupported ( CHostAddress InetAddr ) { ConnectDlg.SetTcpSupported ( InetAddr ); }
+    void OnCLTcpSupported ( CHostAddress InetAddr, int iID ) { ConnectDlg.SetTcpSupported ( InetAddr, iID ); }
 
     void OnCLConnClientsListMesReceived ( CHostAddress InetAddr, CVector<CChannelInfo> vecChanInfo )
     {

src/connectdlg.cpp

@@ -544,16 +544,27 @@ void CConnectDlg::SetServerList ( const CHostAddress& InetAddr, const CVector<CS
     TimerPing.start ( PING_UPDATE_TIME_SERVER_LIST_MS );
 }
 
-void CConnectDlg::SetTcpSupported ( const CHostAddress& InetAddr )
+void CConnectDlg::SetTcpSupported ( const CHostAddress& InetAddr, int iID )
 {
-    qDebug() << "- TCP supported at server" << InetAddr.toString();
+    qDebug() << "- TCP supported at server" << InetAddr.toString() << "for ID =" << iID;
 
-    // if we haven't received the serverlist, it must have got lost due to fragmentation
-    // retry using TCP instead
-    if ( !bServerListReceived )
+    switch ( iID )
     {
-        // send the request for the server list
-        emit ReqServerListQuery ( InetAddr, true ); // TCP
+    case PROTMESSID_CLM_SERVER_LIST:
+        // if we haven't received the serverlist, it must have got lost due to fragmentation
+        // retry using TCP instead
+        if ( !bServerListReceived )
+        {
+            // send the request for the server list
+            emit ReqServerListQuery ( InetAddr, true ); // TCP
+        }
+        break;
+
+    case PROTMESSID_CLM_CONN_CLIENTS_LIST:
+        break;
+
+    default:
+        break;
     }
 }
 

src/connectdlg.h

@@ -69,7 +69,7 @@ class CConnectDlg : public CBaseDlg, private Ui_CConnectDlgBase
 
     void SetServerList ( const CHostAddress& InetAddr, const CVector<CServerInfo>& vecServerInfo, const bool bIsReducedServerList = false );
 
-    void SetTcpSupported ( const CHostAddress& InetAddr );
+    void SetTcpSupported ( const CHostAddress& InetAddr, int iID );
 
     void SetConnClientsList ( const CHostAddress& InetAddr, const CVector<CChannelInfo>& vecChanInfo );
 

src/protocol.cpp

@@ -436,7 +436,14 @@ CONNECTION LESS MESSAGES
 
 - PROTMESSID_CLM_TCP_SUPPORTED: TCP supported message
 
-    note: does not have any data -> n = 0
+    +----------------------------------------------------------+
+    | 2 bytes ID of message to be potentially retried over TCP |
+    +----------------------------------------------------------+
+
+    the ID indicates which type of message preceded it:
+    - PROTMESSID_CLM_SERVER_LIST
+    - PROTMESSID_CLM_CONN_CLIENTS_LIST
+    - 0 (sent on new incoming audio stream)
 
 */
 
@@ -931,7 +938,7 @@ void CProtocol::ParseConnectionLessMessageBody ( const CVector<uint8_t>& vecbyMe
         break;
 
     case PROTMESSID_CLM_TCP_SUPPORTED:
-        EvaluateCLTcpSupportedMes ( InetAddr );
+        EvaluateCLTcpSupportedMes ( InetAddr, vecbyMesBodyData );
         break;
     }
 }
@@ -2596,15 +2603,31 @@ bool CProtocol::EvaluateCLRegisterServerResp ( const CHostAddress& InetAddr, con
     return false; // no error
 }
 
-void CProtocol::CreateCLTcpSupportedMes ( const CHostAddress& InetAddr )
+void CProtocol::CreateCLTcpSupportedMes ( const CHostAddress& InetAddr, const int iID )
 {
-    CreateAndImmSendConLessMessage ( PROTMESSID_CLM_TCP_SUPPORTED, CVector<uint8_t> ( 0 ), InetAddr );
+    int iPos = 0; // init position pointer
+
+    // build data vector (2 bytes long)
+    CVector<uint8_t> vecData ( 2 );
+
+    // message ID just sent (2 bytes)
+    PutValOnStream ( vecData, iPos, static_cast<uint32_t> ( iID ), 2 );
+
+    CreateAndImmSendConLessMessage ( PROTMESSID_CLM_TCP_SUPPORTED, vecData, InetAddr );
 }
 
-bool CProtocol::EvaluateCLTcpSupportedMes ( const CHostAddress& InetAddr )
+bool CProtocol::EvaluateCLTcpSupportedMes ( const CHostAddress& InetAddr, const CVector<uint8_t>& vecData )
 {
+    int iPos = 0; // init position pointer
+
+    // check size
+    if ( vecData.Size() != 2 )
+    {
+        return true; // return error code
+    }
+
     // invoke message action
-    emit CLTcpSupported ( InetAddr );
+    emit CLTcpSupported ( InetAddr, static_cast<int> ( GetValFromStream ( vecData, iPos, 2 ) ) );
 
     return false; // no error
 }

src/protocol.h

@@ -155,7 +155,7 @@ class CProtocol : public QObject
     void CreateCLReqConnClientsListMes ( const CHostAddress& InetAddr, bool bUseTcpClient );
     void CreateCLChannelLevelListMes ( const CHostAddress& InetAddr, const CVector<uint16_t>& vecLevelList, const int iNumClients );
     void CreateCLRegisterServerResp ( const CHostAddress& InetAddr, const ESvrRegResult eResult );
-    void CreateCLTcpSupportedMes ( const CHostAddress& InetAddr );
+    void CreateCLTcpSupportedMes ( const CHostAddress& InetAddr, const int iID );
 
     static int GetBodyLength ( const CVector<uint8_t>& vecbyData );
 
@@ -291,7 +291,7 @@ class CProtocol : public QObject
     bool EvaluateCLReqConnClientsListMes ( const CHostAddress& InetAddr, CTcpConnection* pTcpConnection );
     bool EvaluateCLChannelLevelListMes ( const CHostAddress& InetAddr, const CVector<uint8_t>& vecData );
     bool EvaluateCLRegisterServerResp ( const CHostAddress& InetAddr, const CVector<uint8_t>& vecData );
-    bool EvaluateCLTcpSupportedMes ( const CHostAddress& InetAddr );
+    bool EvaluateCLTcpSupportedMes ( const CHostAddress& InetAddr, const CVector<uint8_t>& vecData );
 
     int iOldRecID;
     int iOldRecCnt;
@@ -358,5 +358,5 @@ public slots:
     void CLReqConnClientsList ( CHostAddress InetAddr, CTcpConnection* pTcpConnection );
     void CLChannelLevelListReceived ( CHostAddress InetAddr, CVector<uint16_t> vecLevelList );
     void CLRegisterServerResp ( CHostAddress InetAddr, ESvrRegResult eStatus );
-    void CLTcpSupported ( CHostAddress InetAddr );
+    void CLTcpSupported ( CHostAddress InetAddr, int iID );
 };

src/server.cpp

@@ -390,7 +390,7 @@ void CServer::OnNewConnection ( int iChID, int iTotChans, CHostAddress RecHostAd
     // if TCP is enabled, we need to announce this first, before sending Client ID
     if ( bEnableTcp )
     {
-        ConnLessProtocol.CreateCLTcpSupportedMes ( vecChannels[iChID].GetAddress() );
+        ConnLessProtocol.CreateCLTcpSupportedMes ( vecChannels[iChID].GetAddress(), 0 );
     }
 
     // inform the client about its own ID at the server (note that this

src/server.h

@@ -374,7 +374,7 @@ public slots:
         // if TCP is enabled but this request is on UDP, say TCP is supported
         if ( bEnableTcp && !pTcpConnection )
         {
-            ConnLessProtocol.CreateCLTcpSupportedMes ( InetAddr );
+            ConnLessProtocol.CreateCLTcpSupportedMes ( InetAddr, PROTMESSID_CLM_CONN_CLIENTS_LIST );
         }
     }
 

src/serverlist.cpp

@@ -736,7 +736,7 @@ void CServerListManager::RetrieveAll ( const CHostAddress& InetAddr, CTcpConnect
         // if TCP is enabled but this request is on UDP, say TCP is supported
         if ( bEnableTcp && !pTcpConnection )
         {
-            pConnLessProtocol->CreateCLTcpSupportedMes ( InetAddr );
+            pConnLessProtocol->CreateCLTcpSupportedMes ( InetAddr, PROTMESSID_CLM_SERVER_LIST );
         }
     }
 }