Rename gracePeriod and timeout

ktorio · Dec 20, 2022 · a532c45 · a532c45
1 parent 2736113
commit a532c45
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 22 deletions.
diff --git a/ktor-server/ktor-server-cio/jvmAndNix/src/io/ktor/server/cio/EngineMain.kt b/ktor-server/ktor-server-cio/jvmAndNix/src/io/ktor/server/cio/EngineMain.kt
@@ -20,9 +20,9 @@ public object EngineMain {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = CIOApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
         val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 50
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong() ?: 50
         val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong() ?: 5000
         engine.addShutdownHook {
             engine.stop(gracePeriod, timeout)
         }

diff --git a/ktor-server/ktor-server-host-common/api/ktor-server-host-common.api b/ktor-server/ktor-server-host-common/api/ktor-server-host-common.api
@@ -10,14 +10,14 @@ public class io/ktor/server/engine/ApplicationEngine$Configuration {
 	public fun <init> ()V
 	public final fun getCallGroupSize ()I
 	public final fun getConnectionGroupSize ()I
-	public final fun getGracePeriodMillis ()J
 	public final fun getParallelism ()I
-	public final fun getTimeoutMillis ()J
+	public final fun getShutdownGracePeriodMillis ()J
+	public final fun getShutdownTimeoutMillis ()J
 	public final fun getWorkerGroupSize ()I
 	public final fun setCallGroupSize (I)V
 	public final fun setConnectionGroupSize (I)V
-	public final fun setGracePeriodMillis (J)V
-	public final fun setTimeoutMillis (J)V
+	public final fun setShutdownGracePeriodMillis (J)V
+	public final fun setShutdownTimeoutMillis (J)V
 	public final fun setWorkerGroupSize (I)V
 }
 

diff --git a/ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/ApplicationEngine.kt b/ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/ApplicationEngine.kt
@@ -41,12 +41,12 @@ public interface ApplicationEngine {
         /**
          * Specifies the maximum amount of time for activity to cool down in milliseconds.
          */
-        public var gracePeriodMillis: Long = 500
+        public var shutdownGracePeriodMillis: Long = 500
 
         /**
          * Specifies the maximum amount of time to wait until a server stops gracefully in milliseconds.
          */
-        public var timeoutMillis: Long = 500
+        public var shutdownTimeoutMillis: Long = 500
     }
 
     /**

diff --git a/ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/CommandLine.kt b/ktor-server/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/CommandLine.kt
@@ -130,11 +130,11 @@ public fun BaseApplicationEngine.Configuration.loadCommonConfiguration(deploymen
     deploymentConfig.propertyOrNull("workerGroupSize")?.getString()?.toInt()?.let {
         workerGroupSize = it
     }
-    deploymentConfig.propertyOrNull("gracePeriod")?.getString()?.toLong()?.let {
-        gracePeriodMillis = it
+    deploymentConfig.propertyOrNull("shutdownGracePeriod")?.getString()?.toLong()?.let {
+        shutdownGracePeriodMillis = it
     }
-    deploymentConfig.propertyOrNull("timeout")?.getString()?.toLong()?.let {
-        timeoutMillis = it
+    deploymentConfig.propertyOrNull("shutdownTimeout")?.getString()?.toLong()?.let {
+        shutdownTimeoutMillis = it
     }
 }
 

diff --git a/ktor-server/ktor-server-jetty/jvm/src/io/ktor/server/jetty/EngineMain.kt b/ktor-server/ktor-server-jetty/jvm/src/io/ktor/server/jetty/EngineMain.kt
@@ -20,9 +20,9 @@ public object EngineMain {
         val applicationEnvironment = commandLineEnvironment(args)
         val engine = JettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
         val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 3000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong() ?: 3000
         val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong() ?: 5000
         engine.addShutdownHook {
             engine.stop(gracePeriod, timeout)
         }

diff --git a/ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/EngineMain.kt b/ktor-server/ktor-server-netty/jvm/src/io/ktor/server/netty/EngineMain.kt
@@ -21,9 +21,9 @@ public object EngineMain {
         val engine = NettyApplicationEngine(applicationEnvironment) { loadConfiguration(applicationEnvironment.config) }
 
         val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 3000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong() ?: 3000
         val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong() ?: 5000
         engine.addShutdownHook {
             engine.stop(gracePeriod, timeout)
         }

diff --git a/ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/ConfigTestSuite.kt b/ktor-server/ktor-server-test-suites/jvm/src/io/ktor/server/testing/suites/ConfigTestSuite.kt
@@ -72,16 +72,16 @@ abstract class ConfigTestSuite(
                 """
                     ktor {
                         deployment {
-                            gracePeriod: 2000,
-                            timeout: 6000
+                            shutdownGracePeriod: 2000,
+                            shutdownTimeout: 6000
                         }
                     }
                 """.trimIndent()
             )
         )
 
         val configuration = configuration().apply { loadCommonConfiguration(config.config("ktor.deployment")) }
-        assertEquals(2000, configuration.gracePeriodMillis)
-        assertEquals(6000, configuration.timeoutMillis)
+        assertEquals(2000, configuration.shutdownGracePeriodMillis)
+        assertEquals(6000, configuration.shutdownTimeoutMillis)
     }
 }
diff --git a/ktor-server/ktor-server-tomcat/jvm/src/io/ktor/server/tomcat/EngineMain.kt b/ktor-server/ktor-server-tomcat/jvm/src/io/ktor/server/tomcat/EngineMain.kt
@@ -22,9 +22,9 @@ public object EngineMain {
             loadConfiguration(applicationEnvironment.config)
         }
         val gracePeriod =
-            engine.environment.config.propertyOrNull("ktor.deployment.gracePeriod")?.getString()?.toLong() ?: 3000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownGracePeriod")?.getString()?.toLong() ?: 3000
         val timeout =
-            engine.environment.config.propertyOrNull("ktor.deployment.timeout")?.getString()?.toLong() ?: 5000
+            engine.environment.config.propertyOrNull("ktor.deployment.shutdownTimeout")?.getString()?.toLong() ?: 5000
         engine.addShutdownHook {
             engine.stop(gracePeriod, timeout)
         }