Explorar el Código

Added comments for SCTP settings

Paul-Louis Ageneau hace 4 años
padre
commit
07a5591cda
Se han modificado 2 ficheros con 13 adiciones y 13 borrados
  1. 6 6
      include/rtc/global.hpp
  2. 7 7
      include/rtc/rtc.h

+ 6 - 6
include/rtc/global.hpp

@@ -47,12 +47,12 @@ RTC_EXPORT void Cleanup();
 
 struct SctpSettings {
 	// For the following settings, not set means optimized default
-	optional<size_t> recvBufferSize;
-	optional<size_t> sendBufferSize;
-	optional<size_t> maxChunksOnQueue;
-	optional<size_t> initialCongestionWindow;
-	optional<size_t> maxBurst;
-	optional<unsigned int> congestionControlModule;
+	optional<size_t> recvBufferSize;                // in bytes
+	optional<size_t> sendBufferSize;                // in bytes
+	optional<size_t> maxChunksOnQueue;              // in chunks
+	optional<size_t> initialCongestionWindow;       // in MTUs
+	optional<size_t> maxBurst;                      // in MTUs
+	optional<unsigned int> congestionControlModule; // 0: RFC2581, 1: HSTCP, 2: H-TCP, 3: RTCC
 	optional<std::chrono::milliseconds> delayedSackTime;
 };
 

+ 7 - 7
include/rtc/rtc.h

@@ -222,13 +222,13 @@ RTC_EXPORT int rtcGetTrackDescription(int tr, char *buffer, int size);
 
 // SCTP settings
 typedef struct {
-	int recvBufferSize;          // <= 0 means optimized default
-	int sendBufferSize;          // <= 0 means optimized default
-	int maxChunksOnQueue;        // <= 0 means optimized default
-	int initialCongestionWindow; // <= 0 means optimized default
-	int maxBurst;				 // 0 means optimized default, < 0 means disabled
-	int congestionControlModule; // <= 0 means default (0: RFC2581, 1: HSTCP, 2: H-TCP, 3: RTCC)
-	int delayedSackTimeMs;       // <= 0 means optimized default
+	int recvBufferSize;          // in bytes, <= 0 means optimized default
+	int sendBufferSize;          // in bytes, <= 0 means optimized default
+	int maxChunksOnQueue;        // in chunks, <= 0 means optimized default
+	int initialCongestionWindow; // in MTUs, <= 0 means optimized default
+	int maxBurst;				 // in MTUs, 0 means optimized default, < 0 means disabled
+	int congestionControlModule; // 0: RFC2581 (default), 1: HSTCP, 2: H-TCP, 3: RTCC
+	int delayedSackTimeMs;       // in msecs, <= 0 means optimized default
 } rtcSctpSettings;
 
 // Note: SCTP settings apply to newly-created PeerConnections only