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

BaseApplicationEngine

abstract class BaseApplicationEngine(environment: ApplicationEngineEnvironment, pipeline: EnginePipeline) : ApplicationEngine

Base class for implementing ApplicationEngine

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

Parameters

environment

instance of ApplicationEngineEnvironment for this engine

pipeline

pipeline to use with this engine

Constructors

BaseApplicationEngine

fun BaseApplicationEngine(environment: ApplicationEngineEnvironment, pipeline: EnginePipeline = defaultEnginePipeline(environment))

Types

open class Configuration : ApplicationEngine.Configuration

Configuration for the BaseApplicationEngine

Functions

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

Starts this ApplicationEngine

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

~~open~~ ~~fun~~ ~~stop~~(~~gracePeriod~~: Long, ~~timeout~~: Long, ~~timeUnit~~: TimeUnit)

Stops this ApplicationEngine

Properties

open val application: Application

Currently running application instance

override val environment: ApplicationEngineEnvironment

val pipeline: EnginePipeline