mediasoup 3.20.0 → 3.20.2

package/worker/include/RTC/SCTP/association/HeartbeatHandler.hpp

@@ -42,13 +42,13 @@ namespace RTC
 			void RestartTimer();
 
 			/**
-			 * Called on received HEARTBEAT_REQUEST Chunk.
+			 * Called on received HEARTBEAT-REQUEST chunk.
 			 */
 			void HandleReceivedHeartbeatRequestChunk(
 			  const HeartbeatRequestChunk* receivedHeartbeatRequestChunk);
 
 			/**
-			 * Called on received HEARTBEAT_ACK Chunk.
+			 * Called on received HEARTBEAT-ACK chunk.
 			 */
 			void HandleReceivedHeartbeatAckChunk(const HeartbeatAckChunk* receivedHeartbeatAckChunk);
 

package/worker/include/RTC/SCTP/association/NegotiatedCapabilities.hpp

@@ -21,7 +21,7 @@ namespace RTC
 			 * the SCTP association handshake flow.
 			 *
 			 * @remarks
-			 * - Given `remoteChunk` must be an INIT or an INIT_ACK Chunk.
+			 * - Given `remoteChunk` must be an INIT or an INIT-ACK chunk.
 			 */
 			static NegotiatedCapabilities Factory(
 			  const SctpOptions& sctpOptions, const AnyInitChunk* remoteChunk);
@@ -44,7 +44,7 @@ namespace RTC
 			bool partialReliability{ false };
 
 			/**
-			 * Stream Schedulers and User Message Interleaving (I-DATA Chunks).
+			 * Stream Schedulers and User Message Interleaving (I-DATA chunks).
 			 *
 			 * @see RFC 8260.
 			 */

package/worker/include/RTC/SCTP/association/PacketSender.hpp

@@ -29,10 +29,10 @@ namespace RTC
 
 		public:
 			/**
-			 * Notifies the parent about a Packet to be sent to the peer and returns a
-			 * boolean indicating whether the Packet was sent or not.
+			 * Notifies the parent about a packet to be sent to the peer and returns a
+			 * boolean indicating whether the packet was sent or not.
 			 *
-			 * This method also writes the Packet checksum field depending on the value
+			 * This method also writes the packet checksum field depending on the value
 			 * of `writeChecksum`.
 			 *
 			 * @remarks

package/worker/include/RTC/SCTP/association/StateCookie.hpp

@@ -14,7 +14,7 @@ namespace RTC
 	{
 		/**
 		 * This is the State Cookie we generate and put into a State Cookie
-		 * Parameter when we send INIT_ACK Chunk to the remote peer.
+		 * parameter when we send INIT-ACK chunk to the remote peer.
 		 *
 		 * The syntax we use is as follows. Note that we use a fixed length of
 		 * StateCookieLength bytes.
@@ -115,7 +115,7 @@ namespace RTC
 			 *
 			 * @remarks
 			 * `bufferLength` could be greater than the real length of the State
-			 * Cookie.
+			 * cookie.
 			 */
 			static StateCookie* Factory(
 			  uint8_t* buffer,
@@ -159,8 +159,8 @@ namespace RTC
 			StateCookie* Clone(uint8_t* buffer, size_t bufferLength) const final;
 
 			/**
-			 * The value of the Initiate Tag field we put in our INIT or INIT_ACK
-			 * Chunk. Packets sent by the remote peer must include this value in
+			 * The value of the Initiate Tag field we put in our INIT or INIT-ACK
+			 * chunk. Packets sent by the remote peer must include this value in
 			 * their Verification Tag field.
 			 */
 			uint32_t GetLocalVerificationTag() const
@@ -170,7 +170,7 @@ namespace RTC
 
 			/**
 			 * The value of the Initiate Tag field the peer put in its INIT or
-			 * INIT_ACK Chunk. Packets sent by us to the peer must include this value
+			 * INIT-ACK chunk. Packets sent by us to the peer must include this value
 			 * in their Verification Tag field.
 			 */
 			uint32_t GetRemoteVerificationTag() const
@@ -179,8 +179,8 @@ namespace RTC
 			}
 
 			/**
-			 * The value of the Initial TSN field we put in our INIT or INIT_ACK
-			 * Chunk.
+			 * The value of the Initial TSN field we put in our INIT or INIT-ACK
+			 * chunk.
 			 */
 			uint32_t GetLocalInitialTsn() const
 			{
@@ -189,7 +189,7 @@ namespace RTC
 
 			/**
 			 * The value of the Initial TSN field the peer put in its INIT or
-			 * INIT_ACK Chunk.
+			 * INIT-ACK chunk.
 			 */
 			uint32_t GetRemoteInitialTsn() const
 			{
@@ -198,7 +198,7 @@ namespace RTC
 
 			/**
 			 * The value of the Advertised Receiver Window Credit field we put in our
-			 * INIT or INIT_ACK Chunk.
+			 * INIT or INIT-ACK chunk.
 			 */
 			uint32_t GetRemoteAdvertisedReceiverWindowCredit() const
 			{

package/worker/include/RTC/SCTP/association/StreamResetHandler.hpp

@@ -195,7 +195,7 @@ namespace RTC
 			bool ShouldSendStreamResetRequest() const;
 
 			/**
-			 * Adds a Reset Streams request to the given Packet. Will start the
+			 * Adds a Reset Streams request to the given packet. Will start the
 			 * reconfig timer.
 			 *
 			 * @remarks
@@ -218,7 +218,7 @@ namespace RTC
 			bool ValidateReceivedReConfigChunk(const ReConfigChunk* receivedReConfigChunk);
 
 			/**
-			 * Adds the actual RE-CONFIG chunk to the given Packet. A request (which
+			 * Adds the actual RE-CONFIG chunk to the given packet. A request (which
 			 * set `this->currentRequest`) must have been created prior.
 			 */
 			void AddReConfigChunk(Packet* packet);
@@ -229,7 +229,7 @@ namespace RTC
 			ReqSeqNbrValidationResult ValidateReqSeqNbr(UnwrappedReConfigRequestSn reqSeqNbr);
 
 			/**
-			 * Called when this Association receives an outgoing stream reset request.
+			 * Called when this association receives an outgoing stream reset request.
 			 * It might either be performed straight away, or have to be deferred, and
 			 * the result of that will be put in `responses`.
 			 */
@@ -238,7 +238,7 @@ namespace RTC
 			  ReConfigChunk* reConfigChunk);
 
 			/**
-			 * Called when this Association receives an incoming stream reset request.
+			 * Called when this association receives an incoming stream reset request.
 			 * This isn't really supported, but a successful response is put in
 			 * `responses`.
 			 */

package/worker/include/RTC/SCTP/association/TransmissionControlBlock.hpp

@@ -67,8 +67,8 @@ namespace RTC
 			}
 
 			/**
-			 * The value of the Initiate Tag field we put in our INIT or INIT_ACK
-			 * Chunk. Packets sent by the remote peer must include this value in
+			 * The value of the Initiate Tag field we put in our INIT or INIT-ACK
+			 * chunk. Packets sent by the remote peer must include this value in
 			 * their Verification Tag field.
 			 */
 			uint32_t GetLocalVerificationTag() const
@@ -78,7 +78,7 @@ namespace RTC
 
 			/**
 			 * The value of the Initiate Tag field the peer put in its INIT or
-			 * INIT_ACK Chunk. Packets sent by us to the peer must include this value
+			 * INIT-ACK chunk. Packets sent by us to the peer must include this value
 			 * in their Verification Tag field.
 			 */
 			uint32_t GetRemoteVerificationTag() const
@@ -87,8 +87,8 @@ namespace RTC
 			}
 
 			/**
-			 * The value of the Initial TSN field we put in our INIT or INIT_ACK
-			 * Chunk.
+			 * The value of the Initial TSN field we put in our INIT or INIT-ACK
+			 * chunk.
 			 *
 			 * @remarks
 			 * - Implements TransmissionControlBlockContextInterface.
@@ -100,7 +100,7 @@ namespace RTC
 
 			/**
 			 * The value of the Initial TSN field the peer put in its INIT or
-			 * INIT_ACK Chunk.
+			 * INIT-ACK chunk.
 			 *
 			 * @remarks
 			 * - Implements TransmissionControlBlockContextInterface.
@@ -112,7 +112,7 @@ namespace RTC
 
 			/**
 			 * The value of the Advertised Receiver Window Credit field we put in our
-			 * INIT or INIT_ACK Chunk.
+			 * INIT or INIT-ACK chunk.
 			 */
 			uint32_t GetRemoteAdvertisedReceiverWindowCredit() const
 			{
@@ -200,17 +200,17 @@ namespace RTC
 			}
 
 			/**
-			 * Will be set while the Association is in COOKIE_ECHOED state. In this
-			 * state, there can only be a single Packet outstanding, and it must
-			 * contain the COOKIE_ECHO Chunk as the first Chunk in that Packet, until
-			 * the COOKIE_ACK has been received, which will make the socket call
+			 * Will be set while the association is in COOKIE_ECHOED state. In this
+			 * state, there can only be a single packet outstanding, and it must
+			 * contain the COOKIE-ECHO chunk as the first chunk in that packet, until
+			 * the COOKIE-ACK has been received, which will make the socket call
 			 * `ClearRemoteStateCookie()`.
 			 */
 			void SetRemoteStateCookie(std::vector<uint8_t> remoteStateCookie);
 
 			/**
-			 * Called when the COOKIE_ACK Chunk has been received, to allow further
-			 * Packets to be sent.
+			 * Called when the COOKIE-ACK chunk has been received, to allow further
+			 * packets to be sent.
 			 */
 			void ClearRemoteStateCookie();
 
@@ -220,12 +220,12 @@ namespace RTC
 			}
 
 			/**
-			 * Sends a SACK Chunk, if there is a need to.
+			 * Sends a SACK chunk, if there is a need to.
 			 */
 			void MaySendSackChunk();
 
 			/**
-			 * May add a FORWARD-TSN or I-FORWARD-TSN Chunk to the given Packet if it
+			 * May add a FORWARD-TSN or I-FORWARD-TSN chunk to the given packet if it
 			 * is needed and allowed (rate-limited).
 			 */
 			void MayAddForwardTsnChunk(Packet* packet, uint64_t nowMs);
@@ -233,12 +233,12 @@ namespace RTC
 			void MaySendFastRetransmit();
 
 			/**
-			 * Create and fill Packets with control and DATA/I-DATA Chunks, and sends
+			 * Create and fill packets with control and DATA/I-DATA chunks, and sends
 			 * them as much as can be allowed by the congestion control algorithm.
 			 *
 			 * @remarks
-			 * - If `this->remoteStateCookie` is present, then only one Packet will be
-			 *   sent, with this Chunk as the first Chunk.
+			 * - If `this->remoteStateCookie` is present, then only one packet will be
+			 *   sent, with this chunk as the first chunk.
 			 * - Cannot pass `addCookieAckChunk=true` if `this->remoteStateCookie` is
 			 *   present (will throw).
 			 */
@@ -300,7 +300,7 @@ namespace RTC
 			// Nonce, used to detect reconnections.
 			uint64_t tieTag;
 			NegotiatedCapabilities negotiatedCapabilities;
-			// Max SCTP Packet length.
+			// Max SCTP packet length.
 			const size_t maxPacketLength;
 			std::function<bool()> isAssociationEstablished;
 			// The data retransmission timer.
@@ -315,14 +315,14 @@ namespace RTC
 			RetransmissionQueue retransmissionQueue;
 			StreamResetHandler streamResetHandler;
 			HeartbeatHandler heartbeatHandler;
-			// Rate limiting of FORWARD_TSN. Next can be sent at or after this
+			// Rate limiting of FORWARD-TSN. Next can be sent at or after this
 			// timestamp.
 			uint64_t limitForwardTsnUntilMs{ 0 };
 			// Only valid when state is State::COOKIE_ECHOED. In this state, the
-			// Association must wait for COOKIE_ACK to continue sending any packets (not
-			// including a COOKIE_ECHO). So if this state cookie is present, the
-			// `SendBufferedChunks()` method will always only send one Packet, with
-			// a CookieEchoChunk containing this cookie as the first Chunk in the Packet.
+			// association must wait for COOKIE-ACK to continue sending any packets (not
+			// including a COOKIE-ECHO). So if this state cookie is present, the
+			// `SendBufferedChunks()` method will always only send one packet, with
+			// a CookieEchoChunk containing this cookie as the first chunk in the packet.
 			std::optional<std::vector<uint8_t>> remoteStateCookie;
 		};
 	} // namespace SCTP

package/worker/include/RTC/SCTP/association/TransmissionControlBlockContextInterface.hpp

@@ -15,19 +15,19 @@ namespace RTC
 			virtual ~TransmissionControlBlockContextInterface() = default;
 
 			/**
-			 * Indicates if the SCTP Association has been established.
+			 * Indicates if the SCTP association has been established.
 			 */
 			virtual bool IsAssociationEstablished() const = 0;
 
 			/**
 			 * The value of the Initiate Tag field the peer put in its INIT or
-			 * INIT_ACK Chunk.
+			 * INIT-ACK chunk.
 			 */
 			virtual uint32_t GetLocalInitialTsn() const = 0;
 
 			/**
 			 * The value of the Initial TSN field the peer put in its INIT or
-			 * INIT_ACK Chunk.
+			 * INIT-ACK chunk.
 			 */
 			virtual uint32_t GetRemoteInitialTsn() const = 0;
 
@@ -62,7 +62,7 @@ namespace RTC
 			virtual std::unique_ptr<Packet> CreatePacket() const = 0;
 
 			/**
-			 * Sends a Packet and returns a boolean indicating whether the Packet was
+			 * Sends a packet and returns a boolean indicating whether the packet was
 			 * sent or not.
 			 */
 			virtual bool SendPacket(Packet* packet) = 0;