ApplicationEngine

interface ApplicationEngine

Engine which runs an application

Types

Configuration

open class Configuration

Configuration for the ApplicationEngine

Properties

application

open val application: Application

Currently running application instance

environment

abstract val environment: ApplicationEngineEnvironment

Environment with which this engine is running

Functions

start

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

Starts this ApplicationEngine

stop

abstract fun stop(
    gracePeriod: Long,
    timeout: Long,
    timeUnit: TimeUnit
): Unit

Stops this ApplicationEngine

Extension Functions

stopServerOnCancellation

fun ApplicationEngine.stopServerOnCancellation(): CompletableJob

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

Inheritors

BaseApplicationEngine

abstract class BaseApplicationEngine : ApplicationEngine

Base class for implementing ApplicationEngine