Add comment explaining DiskS3::shutdown

Jokser · Jokser · commit 5e39f8b32bcd · 2020-09-08T15:20:35.000+03:00
diff --git a/src/Disks/S3/DiskS3.cpp b/src/Disks/S3/DiskS3.cpp
@@ -748,6 +748,10 @@ void DiskS3::setReadOnly(const String & path)
 
 void DiskS3::shutdown()
 {
+    /// This call stops any next retry attempts for ongoing S3 requests.
+    /// If S3 request is failed and the method below is executed S3 client immediately returns the last failed S3 request outcome.
+    /// If S3 is healthy nothing wrong will be happened and S3 requests will be processed in a regular way without errors.
+    /// This should significantly speed up shutdown process if S3 is unhealthy.
     client->DisableRequestProcessing();
 }
 

Original file line number	Diff line number	Diff line change
`@@ -748,6 +748,10 @@ void DiskS3::setReadOnly(const String & path)`
`748`	`748`
`749`	`749`	`void DiskS3::shutdown()`
`750`	`750`	`{`
	`751`	`+ /// This call stops any next retry attempts for ongoing S3 requests.`
	`752`	`+ /// If S3 request is failed and the method below is executed S3 client immediately returns the last failed S3 request outcome.`
	`753`	`+ /// If S3 is healthy nothing wrong will be happened and S3 requests will be processed in a regular way without errors.`
	`754`	`+ /// This should significantly speed up shutdown process if S3 is unhealthy.`
`751`	`755`	`client->DisableRequestProcessing();`
`752`	`756`	`}`
`753`	`757`