mediasoup 3.20.0 → 3.20.2

package/worker/include/RTC/SCTP/packet/Chunk.hpp

@@ -5,8 +5,8 @@
 #include "RTC/SCTP/packet/ErrorCause.hpp"
 #include "RTC/SCTP/packet/Parameter.hpp"
 #include "RTC/SCTP/packet/TLV.hpp"
+#include <ankerl/unordered_dense.h>
 #include <string>
-#include <unordered_map>
 #include <vector>
 
 namespace RTC
@@ -28,13 +28,13 @@ namespace RTC
 		 * \                                                               \
 		 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 		 *
-		 * - Chunk Type (8 bits).
-		 * - Chunk Flags (8 bits).
-		 * - Chunk Length (16 bits): Total length of the Chunk
-		 *   excluding padding bytes. Minimum value is 4 (if Chunk Value is 0
+		 * - Chunk type (8 bits).
+		 * - Chunk flags (8 bits).
+		 * - Chunk length (16 bits): Total length of the chunk
+		 *   excluding padding bytes. Minimum value is 4 (if chunk value is 0
 		 *   bytes). Maximum value is 65535, which means 1 byte of padding.
-		 * - Chunk Value (variable length).
-		 * - Padding: Bytes of padding to make the Chunk total length be
+		 * - Chunk value (variable length).
+		 * - Padding: Bytes of padding to make the chunk total length be
 		 *   multiple of 4 bytes.
 		 */
 
@@ -43,7 +43,7 @@ namespace RTC
 
 		class Chunk : public TLV
 		{
-			// We need that Packet calls protected and private methods in this class.
+			// We need that packet calls protected and private methods in this class.
 			friend class Packet;
 
 		public:
@@ -79,7 +79,7 @@ namespace RTC
 
 			/**
 			 * Action that is taken if the processing endpoint does not recognize the
-			 * Chunk Type.
+			 * chunk type.
 			 */
 			enum class ActionForUnknownChunkType : uint8_t
 			{
@@ -100,10 +100,10 @@ namespace RTC
 				ChunkType type;
 				uint8_t flags;
 				/**
-				 * The value of the Chunk Length field, which represents the total
-				 * length of the Chunk in bytes, including the Chunk Type, Chunk Flags,
-				 * Chunk Length and Chunk Value fields. So if the Chunk Value field is
-				 * zero-length, the Length field must be 4. The Chunk Length field does
+				 * The value of the chunk length field, which represents the total
+				 * length of the chunk in bytes, including the chunk type, chunk flags,
+				 * chunk length and chunk value fields. So if the chunk value field is
+				 * zero-length, the length field must be 4. The chunk length field does
 				 * not count any padding.
 				 */
 				uint16_t length;
@@ -149,16 +149,16 @@ namespace RTC
 
 		public:
 			/**
-			 * Whether given buffer could be a a valid Chunk.
+			 * Whether given buffer could be a a valid chunk.
 			 *
 			 * @param buffer
-			 * @param bufferLength - Can be greater than real Chunk length.
-			 * @param chunkType - If given buffer is a valid Chunk then `chunkType`
+			 * @param bufferLength - Can be greater than real chunk length.
+			 * @param chunkType - If given buffer is a valid chunk then `chunkType`
 			 *   is rewritten to parsed ChunkType.
-			 * @param chunkLength - If given buffer is a valid Chunk then
-			 *   `chunkLength` is rewritten to the value of the Chunk Length field.
-			 * @param padding - If given buffer is a valid Chunk then `padding` is
-			 *   rewritten to the number of padding bytes in the Chunk (only the
+			 * @param chunkLength - If given buffer is a valid chunk then
+			 *   `chunkLength` is rewritten to the value of the chunk length field.
+			 * @param padding - If given buffer is a valid chunk then `padding` is
+			 *   rewritten to the number of padding bytes in the chunk (only the
 			 *   necessary ones to make total length multiple of 4).
 			 */
 			static bool IsChunk(
@@ -171,11 +171,11 @@ namespace RTC
 			static const std::string& ChunkTypeToString(ChunkType chunkType);
 
 		private:
-			static const std::unordered_map<ChunkType, std::string> ChunkType2String;
+			static const ankerl::unordered_dense::map<ChunkType, std::string> ChunkType2String;
 
 		protected:
 			/**
-			 * Constructor is protected because we only want to create Chunk
+			 * Constructor is protected because we only want to create chunk
 			 * instances via Parse() and Factory() in subclasses.
 			 */
 			Chunk(uint8_t* buffer, size_t bufferLength);
@@ -217,7 +217,7 @@ namespace RTC
 			}
 
 			/**
-			 * Whether this type of Chunk can have Parameters. Subclasses must
+			 * Whether this type of chunk can have parameters. Subclasses must
 			 * override this method.
 			 */
 			virtual bool CanHaveParameters() const = 0;
@@ -267,42 +267,42 @@ namespace RTC
 			}
 
 			/**
-			 * Clone given Parameter into Chunk's buffer.
+			 * Clone given parameter into chunk's buffer.
 			 *
 			 * @remarks
 			 * - Once this method is called, the caller may want to free the original
-			 *   given Parameter (otherwise it will leak since the Chunk manages a clone
+			 *   given parameter (otherwise it will leak since the chunk manages a clone
 			 *   of it).
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Parameters.
+			 * - MediaSoupError - If the chunk subclass cannot have parameters.
 			 * - MediaSoupError - If `BuildParameterInPlace()` or
 			 *   `BuildErrorCauseInPlace()` was called before and the caller didn't
-			 *   invoke `Consolidate()` on the returned Parameter or Error Cause yet.
+			 *   invoke `Consolidate()` on the returned parameter or error cause yet.
 			 */
 			virtual void AddParameter(const Parameter* parameter) final;
 
 			/**
-			 * Build a Parameter within the Chunk's buffer and append it to the list
-			 * of Parameters. The caller can perform modifications in that Parameter
-			 * and those will affect the Chunk body where the Parameter is serialized.
-			 * The desired Parameter class type is given via template argument.
+			 * Build a parameter within the chunk's buffer and append it to the list
+			 * of parameters. The caller can perform modifications in that parameter
+			 * and those will affect the chunk body where the parameter is serialized.
+			 * The desired parameter class type is given via template argument.
 			 *
-			 * @returns Pointer of the created Parameter specific class.
+			 * @returns Pointer of the created parameter specific class.
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Parameters.
+			 * - MediaSoupError - If the chunk subclass cannot have parameters.
 			 * - MediaSoupError - If `BuildParameterInPlace()` or
 			 *   `BuildErrorCauseInPlace()` was called before and the caller didn't
-			 *   invoke `Consolidate()` on the returned Parameter or Error Cause yet.
+			 *   invoke `Consolidate()` on the returned parameter or error cause yet.
 			 *
 			 * @remarks
-			 * - The caller MUST invoke `Consolidate()` once the Parameter is
+			 * - The caller MUST invoke `Consolidate()` once the parameter is
 			 *   completed.
-			 * - The caller MUST NOT free the obtained Parameter pointer since it's
-			 *   now part of the Chunk.
-			 * - The caller MUST free the obtained Parameter only in case the
-			 *   `Consolidate()` method on the Parameter throws.
+			 * - The caller MUST NOT free the obtained parameter pointer since it's
+			 *   now part of the chunk.
+			 * - The caller MUST free the obtained parameter only in case the
+			 *   `Consolidate()` method on the parameter throws.
 			 * - Method implemented in header file due to C++ template usage.
 			 *
 			 * @example
@@ -317,18 +317,18 @@ namespace RTC
 				AssertCanHaveParameters();
 				AssertDoesNotNeedConsolidation();
 
-				// The new Parameter will be added after other Parameters in the Chunk,
-				// this is, at the end of the Chunk, whose length we know it's padded to
-				// 4 bytes, and each Parameter total length is also multiple of 4 bytes.
+				// The new parameter will be added after other parameters in the chunk,
+				// this is, at the end of the chunk, whose length we know it's padded to
+				// 4 bytes, and each parameter total length is also multiple of 4 bytes.
 				auto* ptr = const_cast<uint8_t*>(GetBuffer()) + GetLength();
 				// The remaining length in the buffer is the potential buffer length
-				// of the Parameter.
+				// of the parameter.
 				size_t parameterMaxBufferLength = GetBufferLength() - (ptr - GetBuffer());
 
 				auto* parameter = T::Factory(ptr, parameterMaxBufferLength);
 
-				// NOTE: Do not fix/update the Parameter buffer length since the caller
-				// probably wants to modify the Parameter.
+				// NOTE: Do not fix/update the parameter buffer length since the caller
+				// probably wants to modify the parameter.
 
 				HandleInPlaceParameter(parameter);
 
@@ -336,7 +336,7 @@ namespace RTC
 			}
 
 			/**
-			 * Whether this type of Chunk can have Error Causes. Subclasses must
+			 * Whether this type of chunk can have error causes. Subclasses must
 			 * override this method.
 			 */
 			virtual bool CanHaveErrorCauses() const = 0;
@@ -386,43 +386,43 @@ namespace RTC
 			}
 
 			/**
-			 * Clone given Error Cause into Chunk's buffer.
+			 * Clone given error cause into chunk's buffer.
 			 *
 			 * @remarks
 			 * - Once this method is called, the caller may want to free the original
-			 *   given Error Cause (otherwise it will leak since the Chunk manages a
+			 *   given error cause (otherwise it will leak since the chunk manages a
 			 *   clone of it).
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Error Causes.
+			 * - MediaSoupError - If the chunk subclass cannot have error causes.
 			 * - MediaSoupError - If `BuildParameterInPlace()` or
 			 *   `BuildErrorCauseInPlace()` was called before and the caller didn't
-			 *   invoke `Consolidate()` on the returned Parameter or Error Cause yet.
+			 *   invoke `Consolidate()` on the returned parameter or error cause yet.
 			 */
 			virtual void AddErrorCause(const ErrorCause* errorCause) final;
 
 			/**
-			 * Build a Error Cause within the Chunk's buffer and append it to the
-			 * list of Error Causes. The caller can perform modifications in that
-			 * Error Cause and those will affect the Chunk body where the Error Cause
-			 * is serialzed. The desired Error Cause class type is given via template
+			 * Build a error cause within the chunk's buffer and append it to the
+			 * list of error causes. The caller can perform modifications in that
+			 * error cause and those will affect the chunk body where the error cause
+			 * is serialzed. The desired error cause class type is given via template
 			 * argument.
 			 *
-			 * @returns Pointer of the created Error Cause specific class.
+			 * @returns Pointer of the created error cause specific class.
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Error Causes.
+			 * - MediaSoupError - If the chunk subclass cannot have error causes.
 			 * - MediaSoupError - If `BuildParameterInPlace()` or
 			 *   `BuildErrorCauseInPlace()` was called before and the caller didn't
-			 *   invoke `Consolidate()` on the returned Parameter or Error Cause yet.
+			 *   invoke `Consolidate()` on the returned parameter or error cause yet.
 			 *
 			 * @remarks
-			 * - The caller MUST invoke `Consolidate()` once the Error Cause is
+			 * - The caller MUST invoke `Consolidate()` once the error cause is
 			 *   completed.
-			 * - The caller MUST NOT free the obtained Error Cause pointer since it's
-			 *   now part of the Chunk.
-			 * - The caller MUST free the obtained Error Cause only in case the
-			 *   `Consolidate()` method on the Error Cause throws.
+			 * - The caller MUST NOT free the obtained error cause pointer since it's
+			 *   now part of the chunk.
+			 * - The caller MUST free the obtained error cause only in case the
+			 *   `Consolidate()` method on the error cause throws.
 			 * - Method implemented in header file due to C++ template usage.
 			 *
 			 * @example
@@ -437,19 +437,19 @@ namespace RTC
 				AssertCanHaveErrorCauses();
 				AssertDoesNotNeedConsolidation();
 
-				// The new Error Cause will be added after other Error Causes in the
-				// Chunk, this is, at the end of the Chunk, whose length we know it's
-				// padded to 4 bytes, and each Error Cause total length is also
+				// The new error cause will be added after other error causes in the
+				// chunk, this is, at the end of the chunk, whose length we know it's
+				// padded to 4 bytes, and each error cause total length is also
 				// multiple of 4 bytes.
 				auto* ptr = const_cast<uint8_t*>(GetBuffer()) + GetLength();
 				// The remaining length in the buffer is the potential buffer length
-				// of the Error Cause.
+				// of the error cause.
 				size_t errorCauseMaxBufferLength = GetBufferLength() - (ptr - GetBuffer());
 
 				auto* errorCause = T::Factory(ptr, errorCauseMaxBufferLength);
 
-				// NOTE: Do not fix/update the Error Cause buffer length since the
-				// caller probably wants to modify the Error Cause.
+				// NOTE: Do not fix/update the error cause buffer length since the
+				// caller probably wants to modify the error cause.
 
 				HandleInPlaceErrorCause(errorCause);
 
@@ -459,7 +459,7 @@ namespace RTC
 			/**
 			 * Whether `BuildParameterInPlace()` or `BuildErrorCauseInPlace()` was
 			 * called before and the caller didn't invoke `Consolidate()` on the
-			 * returned Parameter or Error Cause yet.
+			 * returned parameter or error cause yet.
 			 */
 			virtual bool NeedsConsolidation() const final
 			{
@@ -576,8 +576,8 @@ namespace RTC
 			/**
 			 * Chunk subclasses with header bigger than default one (4 bytes) must
 			 * override this method and return their header length (excluding
-			 * variable-length field considered "value", Optional/Variable-Length
-			 * Parameters and Error Causes).
+			 * variable-length field considered "value", Optional/variable-length
+			 * parameters and error causes).
 			 */
 			size_t GetHeaderLength() const override
 			{
@@ -585,34 +585,34 @@ namespace RTC
 			}
 
 			/**
-			 * To be called by each subclass of Chunk if Parameters parsing is
-			 * needed. It creates Parameter subclasses and adds them to the Chunk.
+			 * To be called by each subclass of chunk if parameters parsing is
+			 * needed. It creates parameter subclasses and adds them to the chunk.
 			 *
 			 * @remarks
-			 * - This method assumes that the Chunk basic parsing has been made
-			 *   already so current length of the Chunk is the fixed length of the
-			 *   specific Chunk class.
+			 * - This method assumes that the chunk basic parsing has been made
+			 *   already so current length of the chunk is the fixed length of the
+			 *   specific chunk class.
 			 *
-			 * @return True if no error happened while parsing Parameters.
+			 * @return True if no error happened while parsing parameters.
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Chunk Parameters.
+			 * - MediaSoupError - If the chunk subclass cannot have chunk parameters.
 			 */
 			virtual bool ParseParameters() final;
 
 			/**
-			 * To be called by each subclass of Chunk if Error Causes parsing is
-			 * needed. It creates ErrorCause subclasses and adds them to the Chunk.
+			 * To be called by each subclass of chunk if error causes parsing is
+			 * needed. It creates ErrorCause subclasses and adds them to the chunk.
 			 *
 			 * @remarks
-			 * - This method assumes that the Chunk basic parsing has been made
-			 *   already so current length of the Chunk is the fixed length of the
-			 *   specific Chunk class.
+			 * - This method assumes that the chunk basic parsing has been made
+			 *   already so current length of the chunk is the fixed length of the
+			 *   specific chunk class.
 			 *
-			 * @return True if no error happened while parsing Error Causes.
+			 * @return True if no error happened while parsing error causes.
 			 *
 			 * @throw
-			 * - MediaSoupError - If the Chunk subclass cannot have Chunk Parameters.
+			 * - MediaSoupError - If the chunk subclass cannot have chunk parameters.
 			 */
 			virtual bool ParseErrorCauses() final;
 
@@ -658,7 +658,7 @@ namespace RTC
 			std::vector<ErrorCause*> errorCauses;
 			// Whether `BuildParameterInPlace()` or `BuildErrorCauseInPlace()` was
 			// called and the caller didn't invoke `Consolidate()` on the returned
-			// Parameter or Error Cause yet.
+			// parameter or error cause yet.
 			bool needsConsolidation{ false };
 		};
 	} // namespace SCTP

package/worker/include/RTC/SCTP/packet/ErrorCause.hpp

@@ -3,8 +3,8 @@
 
 #include "common.hpp"
 #include "RTC/SCTP/packet/TLV.hpp"
+#include <ankerl/unordered_dense.h>
 #include <string>
-#include <unordered_map>
 
 namespace RTC
 {
@@ -25,12 +25,12 @@ namespace RTC
 		 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 		 *
 		 * - Cause Code (16 bits).
-		 * - Cause Length (16 bits): Set to the size of the Error Cause in bytes,
-		 *   including the Cause Code, Cause Length, and Cause-Specific Information
+		 * - Cause length (16 bits): Set to the size of the error cause in bytes,
+		 *   including the Cause Code, Cause length, and Cause-Specific Information
 		 *   fields (padding excluded).
 		 * - Cause-Specific Information (variable length): This field carries the
 		 *   details of the error condition.
-		 * - Padding: Bytes of padding to make the Error Cause total length be
+		 * - Padding: Bytes of padding to make the error cause total length be
 		 *   multiple of 4 bytes.
 		 */
 
@@ -39,7 +39,7 @@ namespace RTC
 
 		class ErrorCause : public TLV
 		{
-			// We need that Chunk calls protected and private methods in this class.
+			// We need that chunk calls protected and private methods in this class.
 			friend class Chunk;
 
 		public:
@@ -75,11 +75,11 @@ namespace RTC
 			{
 				ErrorCauseCode code;
 				/**
-				 * The value of the Error Cause Length field, which represents the
-				 * total length of the Error Cause in bytes, including the Cause Code,
-				 * Cause Length and Cause-Specific Information fields. So if the
-				 * Cause-Specific Information field is zero-length, the Length field
-				 * must be 4. The Cause Length field does not count any padding.
+				 * The value of the error cause length field, which represents the
+				 * total length of the error cause in bytes, including the Cause Code,
+				 * Cause length and Cause-Specific Information fields. So if the
+				 * Cause-Specific Information field is zero-length, the length field
+				 * must be 4. The Cause length field does not count any padding.
 				 */
 				uint16_t length;
 			};
@@ -89,16 +89,16 @@ namespace RTC
 
 		public:
 			/**
-			 * Whether given buffer could be a a valid Error Cause.
+			 * Whether given buffer could be a a valid error cause.
 			 *
 			 * @param buffer
-			 * @param bufferLength - Can be greater than real Error Cause length.
-			 * @param causeCode - If given buffer is a valid Error Cause then
+			 * @param bufferLength - Can be greater than real error cause length.
+			 * @param causeCode - If given buffer is a valid error cause then
 			 *   `causeCode` is rewritten to parsed ErrorCauseCode.
-			 * @param causeLength - If given buffer is a valid Error Cause then
-			 *   `causeLength` is rewritten to the value of the Cause Length field.
-			 * @param padding - If given buffer is a valid Error Cause then `padding`
-			 *   is rewritten to the number of padding bytes in the Error Cause (only
+			 * @param causeLength - If given buffer is a valid error cause then
+			 *   `causeLength` is rewritten to the value of the Cause length field.
+			 * @param padding - If given buffer is a valid error cause then `padding`
+			 *   is rewritten to the number of padding bytes in the error cause (only
 			 *   the necessary ones to make total length multiple of 4).
 			 */
 			static bool IsErrorCause(
@@ -111,7 +111,7 @@ namespace RTC
 			static const std::string& ErrorCauseCodeToString(ErrorCauseCode causeCode);
 
 		private:
-			static const std::unordered_map<ErrorCauseCode, std::string> ErrorCauseCode2String;
+			static const ankerl::unordered_dense::map<ErrorCauseCode, std::string> ErrorCauseCode2String;
 
 		protected:
 			/**

package/worker/include/RTC/SCTP/packet/Packet.hpp

@@ -27,7 +27,7 @@ namespace RTC
 		 * |                           Chunk #n                            |
 		 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 		 *
-		 * It's mandatory that the Packet total length is multiple of 4 bytes.
+		 * It's mandatory that the packet total length is multiple of 4 bytes.
 		 */
 
 		/**
@@ -73,28 +73,28 @@ namespace RTC
 			static const size_t CommonHeaderLength{ 12 };
 
 			/**
-			 * Whether given buffer could be a valid SCTP Packet.
+			 * Whether given buffer could be a valid SCTP packet.
 			 *
 			 * @remarks
-			 * - `bufferLength` must be the exact length of the Packet.
+			 * - `bufferLength` must be the exact length of the packet.
 			 * - This check is very lazy. It should NEVER be done before checking if
 			 *   given buffer is an RTP or RTCP packet.
 			 */
 			static bool IsSctp(const uint8_t* buffer, size_t bufferLength);
 
 			/**
-			 * Parse an SCTP Packet.
+			 * Parse an SCTP packet.
 			 *
 			 * @remarks
-			 * - `bufferLength` must be the exact length of the Packet.
+			 * - `bufferLength` must be the exact length of the packet.
 			 */
 			static Packet* Parse(const uint8_t* buffer, size_t bufferLength);
 
 			/**
-			 * Create an SCTP Packet.
+			 * Create an SCTP packet.
 			 *
 			 * @remarks
-			 * - `bufferLength` must be the exact length of the STUN Packet.
+			 * - `bufferLength` must be the exact length of the STUN packet.
 			 * - If `transactionId` is not given then a random Transaction ID is
 			 *   generated.
 			 */
@@ -102,8 +102,8 @@ namespace RTC
 
 		private:
 			/**
-			 * Constructor is private because we only want to create Packet instances
-			 * via Parse() and Factory().
+			 * Constructor is private because we only want to create packet instances
+			 * via `Parse()` and `Factory()`.
 			 */
 			Packet(uint8_t* buffer, size_t bufferLength);
 
@@ -189,39 +189,39 @@ namespace RTC
 			}
 
 			/**
-			 * Clone given Chunk into Packet's buffer.
+			 * Clone given chunk into packet's buffer.
 			 *
 			 * @remarks
 			 * - Once this method is called, the caller may want to free the original
-			 *   given Chunk (otherwise it will leak since the Packet manages a clone
+			 *   given chunk (otherwise it will leak since the packet manages a clone
 			 *   of it).
 			 *
 			 * @throw
 			 * - MediaSoupError - If `BuildChunkInPlace()` was called before and the
-			 *   caller didn't invoke `Consolidate()` on the returned Chunk yet.
+			 *   caller didn't invoke `Consolidate()` on the returned chunk yet.
 			 */
 			void AddChunk(const Chunk* chunk);
 
 			/**
-			 * Build a Chunk within the Packet's buffer and append it to the list of
-			 * Chunks. The caller can perform modifications in that Chunk and those
-			 * will affect the Packet body where the Chunk is serialzed. The desired
-			 * Chunk class type is given via template argument.
+			 * Build a chunk within the packet's buffer and append it to the list of
+			 * chunks. The caller can perform modifications in that chunk and those
+			 * will affect the packet body where the chunk is serialzed. The desired
+			 * chunk class type is given via template argument.
 			 *
-			 * @returns Pointer of the created Chunk specific class.
+			 * @returns Pointer of the created chunk specific class.
 			 *
 			 * @throw
 			 * - MediaSoupError - If `BuildChunkInPlace()` was called before and the
-			 *   caller didn't invoke `Consolidate()` on the returned Chunk yet.
+			 *   caller didn't invoke `Consolidate()` on the returned chunk yet.
 			 *
 			 * @remarks
-			 * - The caller MUST invoke `Consolidate()` once the Chunk is completed.
-			 * - The caller MUST NOT call `BuildChunkInPlace()` while other Chunk is
+			 * - The caller MUST invoke `Consolidate()` once the chunk is completed.
+			 * - The caller MUST NOT call `BuildChunkInPlace()` while other chunk is
 			 *   in progress.
-			 * - The caller MUST NOT free the obtained Chunk pointer since it's now
-			 *   part of the Packet.
-			 * - The caller MUST free the obtained Chunk only in case the
-			 *   `Consolidate()` method on the Chunk throws.
+			 * - The caller MUST NOT free the obtained chunk pointer since it's now
+			 *   part of the packet.
+			 * - The caller MUST free the obtained chunk only in case the
+			 *   `Consolidate()` method on the chunk throws.
 			 * - Method implemented in header file due to C++ template usage.
 			 *
 			 * @example
@@ -234,18 +234,18 @@ namespace RTC
 			{
 				AssertDoesNotNeedConsolidation();
 
-				// The new Chunk will be added after other Chunks in the Packet, this is,
-				// at the end of the Packet,  whose length we know it's padded to 4
-				// bytes, and each Parameter total length is also multiple of 4 bytes.
+				// The new chunk will be added after other chunks in the packet, this is,
+				// at the end of the packet, whose length we know it's padded to 4 bytes,
+				// and each parameter total length is also multiple of 4 bytes.
 				auto* ptr = const_cast<uint8_t*>(GetBuffer()) + GetLength();
 				// The remaining length in the buffer is the potential buffer length
-				// of the Chunk.
+				// of the chunk.
 				size_t chunkMaxBufferLength = GetBufferLength() - (ptr - GetBuffer());
 
 				auto* chunk = T::Factory(ptr, chunkMaxBufferLength);
 
-				// NOTE: Do not fix/update the Chunk buffer length since the caller
-				// probably wants to modify the Chunk.
+				// NOTE: Do not fix/update the chunk buffer length since the caller
+				// probably wants to modify the chunk.
 
 				HandleInPlaceChunk(chunk);
 
@@ -254,7 +254,7 @@ namespace RTC
 
 			/**
 			 * Whether `BuildChunkInPlace()` was called and the caller didn't invoke
-			 * `Consolidate()` on the returned Chunk yet.
+			 * `Consolidate()` on the returned chunk yet.
 			 */
 			bool NeedsConsolidation() const
 			{
@@ -262,7 +262,7 @@ namespace RTC
 			}
 
 			/**
-			 * Calculate CRC32C value of the whole Packet and insert it into the
+			 * Calculate CRC32C value of the whole packet and insert it into the
 			 * Checksum field.
 			 */
 			void WriteCRC32cChecksum();
@@ -295,7 +295,7 @@ namespace RTC
 			// Chunks.
 			std::vector<Chunk*> chunks;
 			// Whether `BuildChunkInPlace()` was called and the caller didn't invoke
-			// `Consolidate()` on the returned Chunk yet.
+			// `Consolidate()` on the returned chunk yet.
 			bool needsConsolidation{ false };
 		};
 	} // namespace SCTP