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

BaseApplicationEngine

abstract class BaseApplicationEngine( val environment: ApplicationEnvironment, monitor: Events, developmentMode: Boolean, val pipeline: EnginePipeline = defaultEnginePipeline(environment.config, developmentMode)) : ApplicationEngine

Base class for implementing ApplicationEngine

It creates default engine pipeline, provides application property and installs default transformations on respond and receive

Report a problem

Parameters

environment

instance of ApplicationEnvironment for this engine

pipeline

pipeline to use with this engine

Constructors

BaseApplicationEngine

constructor(environment: ApplicationEnvironment, monitor: Events, developmentMode: Boolean, pipeline: EnginePipeline = defaultEnginePipeline(environment.config, developmentMode))

Types

Configuration

open class Configuration : ApplicationEngine.Configuration

Configuration for the BaseApplicationEngine.

Properties

environment

override val environment: ApplicationEnvironment

pipeline

val pipeline: EnginePipeline

Functions

resolvedConnectors

open suspend override 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.

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.