BaseApplicationEngine
abstract class BaseApplicationEngine : 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
Types
open class Configuration : Configuration Configuration for the BaseApplicationEngine |
Constructors
BaseApplicationEngine( Base class for implementing ApplicationEngine |
Properties
val environment: ApplicationEngineEnvironment instance of ApplicationEngineEnvironment for this engine |
|
val pipeline: EnginePipeline pipeline to use with this engine |
Inherited Properties
open val application: Application Currently running application instance |
Inherited Functions
abstract fun start(wait: Boolean = false): ApplicationEngine Starts this ApplicationEngine |
|
Stops this ApplicationEngine |
Extension Functions
fun ApplicationEngine.addShutdownHook(stop: () -> Unit): Unit 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. |
|
fun ApplicationEngine.stop( Stops this ApplicationEngine |
|
fun ApplicationEngine.stopServerOnCancellation(): CompletableJob Stop server on job cancellation. The returned deferred need to be completed or cancelled. |
Inheritors
class CIOApplicationEngine : BaseApplicationEngine Engine that based on CIO backend |
|
open class JettyApplicationEngineBase : BaseApplicationEngine ApplicationEngine base type for running in a standalone Jetty |
|
class NettyApplicationEngine : BaseApplicationEngine ApplicationEngine implementation for running in a standalone Netty |
|
class TestApplicationEngine : ktor test engine that provides way to simulate application calls to existing application module(s) without actual HTTP connection |
|
class TomcatApplicationEngine : BaseApplicationEngine Tomcat application engine that runs it in embedded mode |