Apply suggestions from code review

(further impossible fixes pending) Co-authored-by: Maxim Sharabayko <maxlovic@gmail.com>
Haivision · Feb 28, 2024 · 283021e · 283021e
1 parent 1830e3a
commit 283021e
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 8 deletions.
diff --git a/srtcore/buffer_rcv.cpp b/srtcore/buffer_rcv.cpp
@@ -656,7 +656,6 @@ int CRcvBuffer::readMessage(char* data, size_t len, SRT_MSGCTRL* msgctrl, pair<i
         return 0;
     }
 
-    //const bool canReadInOrder = m_iFirstNonreadPos != m_iStartPos;
     const int readPos = canReadInOrder ? m_iStartPos : m_iFirstNonOrderMsgPos;
     const bool isReadingFromStart = (readPos == m_iStartPos); // Indicates if the m_iStartPos can be changed
 

diff --git a/srtcore/buffer_rcv.h b/srtcore/buffer_rcv.h
@@ -40,10 +40,10 @@ namespace srt
 //   m_pUnit[i]->status_: 0: free, 1: good, 2: read, 3: dropped (can be combined with read?)
 //
 //   thread safety:
-//    start_pos_:      CUDT::m_RecvLock
+//    m_iStartPos:      CUDT::m_RecvLock
 //    first_unack_pos_:    CUDT::m_AckLock
-//    max_pos_inc_:        none? (modified on add and ack
-//    first_nonread_pos_:
+//    m_iMaxPosOff:        none? (modified on add and ack
+//    m_iFirstNonreadPos:
 //
 //
 //    m_iStartPos: the first packet that should be read (might be empty)
@@ -455,7 +455,7 @@ class CRcvBuffer
         return m_iMaxPosOff;
     }
 
-    // Unfortunately it still needs locking.
+    // Returns true if the buffer is full. Requires locking.
     bool full() const
     {
         return size() == capacity();

diff --git a/srtcore/core.cpp b/srtcore/core.cpp
@@ -5544,7 +5544,7 @@ void * srt::CUDT::tsbpd(void* param)
             tsNextDelivery = steady_clock::time_point(); // Ready to read, nothing to wait for.
         }
 
-        SRT_ATR_UNUSED bool wakeup_on_signal = true;
+        SRT_ATR_UNUSED bool bWakeupOnSignal = true;
 
         // We may just briefly unlocked the m_RecvLock, so we need to check m_bClosing again to avoid deadlock.
         if (self->m_bClosing)
@@ -8183,7 +8183,7 @@ int srt::CUDT::sendCtrlAck(CPacket& ctrlpkt, int size)
             }
         }
 #endif
-        // Signalling m_RecvDataCond is not dane when TSBPD is on.
+        // Signalling m_RecvDataCond is not done when TSBPD is on.
         // This signalling is done in file mode in order to keep the
         // API reader thread sleeping until there is a "bigger portion"
         // of data to read. In TSBPD mode this isn't done because every

diff --git a/srtcore/core.h b/srtcore/core.h
@@ -987,7 +987,7 @@ class CUDT
 
     sync::CThread m_RcvTsbPdThread;              // Rcv TsbPD Thread handle
     sync::Condition m_RcvTsbPdCond;              // TSBPD signals if reading is ready. Use together with m_RecvLock
-    sync::atomic<bool> m_bWakeOnRecv;            // Expected to be woken up when received a packet
+    sync::atomic<bool> m_bWakeOnRecv;            // Expected to wake up TSBPD when a read-ready data packet is received.
     sync::Mutex m_RcvTsbPdStartupLock;           // Protects TSBPD thread creating and joining
 
     CallbackHolder<srt_listen_callback_fn> m_cbAcceptHook;