io.ktor.server.netty / NettyApplicationEngine

NettyApplicationEngine

class NettyApplicationEngine : BaseApplicationEngine

ApplicationEngine implementation for running in a standalone Netty

Types

Configuration

class Configuration : Configuration

Configuration for the NettyApplicationEngine

Constructors

<init>

NettyApplicationEngine(
    environment: ApplicationEngineEnvironment, 
    configure: Configuration.() -> Unit = {})

ApplicationEngine implementation for running in a standalone Netty

Inherited Properties

environment	`val environment: ApplicationEngineEnvironment` instance of ApplicationEngineEnvironment for this engine
pipeline	`val pipeline: EnginePipeline` pipeline to use with this engine

Functions

start	`fun start(wait: Boolean): NettyApplicationEngine` Starts this ApplicationEngine
stop	`fun stop( gracePeriod: Long, timeout: Long, timeUnit: TimeUnit ): Unit` Stops this ApplicationEngine
toString	`fun toString(): String`

Extension Functions

addShutdownHook

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.

stopServerOnCancellation

fun ApplicationEngine.stopServerOnCancellation(): CompletableJob

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