ktor-server-host-common/io.ktor.server.engine/ApplicationEngine

ApplicationEngine

interface ApplicationEngine
Content copied to clipboard

Engine which runs an application

Types

Link copied to clipboard
open class Configuration
Content copied to clipboard

Configuration for the ApplicationEngine

Functions

Link copied to clipboard
abstract fun start(wait: Boolean = false): ApplicationEngine
Content copied to clipboard

Starts this ApplicationEngine

Link copied to clipboard
abstract fun stop(gracePeriodMillis: Long, timeoutMillis: Long)
Content copied to clipboard
open fun stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit)
Content copied to clipboard

Stops this ApplicationEngine

Properties

Link copied to clipboard
open val application: Application
Content copied to clipboard

Currently running application instance

Link copied to clipboard
abstract val environment: ApplicationEngineEnvironment
Content copied to clipboard

Environment with which this engine is running

Inheritors

Link copied to clipboard

Extensions

Link copied to clipboard
fun ApplicationEngine.addShutdownHook(stop: () -> Unit)
Content copied to clipboard

Adds automatic JVM shutdown hooks management. Should be used before starting the engine. Once JVM termination noticed, stop block will be executed. Please note that a shutdown hook only registered when the application is running. If the application is already stopped then there will be no hook and no stop function invocation possible. So stop block will be called once or never.

Link copied to clipboard
fun ApplicationEngine.stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit)
Content copied to clipboard

Stops this ApplicationEngine

Link copied to clipboard
fun ApplicationEngine.stopServerOnCancellation(): CompletableJob
Content copied to clipboard

Stop server on job cancellation. The returned deferred need to be completed or cancelled.