ktor-server-core/io.ktor.server.engine/ApplicationEngine

ApplicationEngine

interface ApplicationEngine(source)

An engine which runs an application.

Report a problem

Inheritors

BaseApplicationEngine

Types

Configuration

open class Configuration

A configuration for the ApplicationEngine.

Properties

environment

abstract val environment: ApplicationEnvironment

An environment used to run this engine.

Functions

resolvedConnectors

abstract suspend fun resolvedConnectors(): List<EngineConnectorConfig>

Local addresses for application connectors. If environment's connectors was configured to use port=0, you can use this function to get an actual port for these connectors. Available after a server is started.

start

abstract fun start(wait: Boolean = false): ApplicationEngine

Starts this ApplicationEngine.

startSuspend

open suspend fun startSuspend(wait: Boolean = false): ApplicationEngine

Starts this ApplicationEngine.

stop

abstract fun stop(gracePeriodMillis: Long = 500, timeoutMillis: Long = 500)

Stops this ApplicationEngine.

stop

fun ApplicationEngine.stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit)

Stops this ApplicationEngine

stopServerOnCancellation

fun ApplicationEngine.stopServerOnCancellation(application: Application, gracePeriodMillis: Long = 50, timeoutMillis: Long = 5000): CompletableJob

Stop server on job cancellation. The returned CompletableJob needs to be completed or cancelled.

stopSuspend

open suspend fun stopSuspend(gracePeriodMillis: Long = 500, timeoutMillis: Long = 500)

Stops this ApplicationEngine.