Added explanation

dotnet · Aug 12, 2023 · eb802ea · eb802ea
1 parent 3bf7bbf
commit eb802ea
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/...ter/Consensus/Raft/TransportServices/ConnectionOriented/ProtocolStream.WriteOperations.cs b/...ter/Consensus/Raft/TransportServices/ConnectionOriented/ProtocolStream.WriteOperations.cs
@@ -151,7 +151,10 @@ internal async ValueTask WriteAppendEntriesRequestAsync<TEntry, TList>(ClusterMe
         {
             var entry = entries[i];
 
-            if (this.buffer.Length - bufferEnd < LogEntryMetadata.Size + FrameHeadersSize + 1)
+            // remaining buffer should have free space enough for placing a frame with
+            // log entry metadata and at least 1 byte for the payload
+            const int minimumBufferSizeForLogEntry = LogEntryMetadata.Size + FrameHeadersSize + 1;
+            if (this.buffer.Length - bufferEnd < minimumBufferSizeForLogEntry)
                 await FlushCoreAsync(token).ConfigureAwait(false);
 
             PrepareForWrite(bufferEnd + WriteLogEntryMetadata(this.buffer.Span.Slice(bufferEnd), entry));