JettyApplicationEngine

class JettyApplicationEngine : JettyApplicationEngineBase

ApplicationEngine implementation for running in a standalone Jetty

Constructors

<init>

JettyApplicationEngine(
    environment: ApplicationEngineEnvironment,
    configure: Configuration.() -> Unit)

ApplicationEngine implementation for running in a standalone Jetty

Inherited Properties

configuration

val configuration: Configuration

Application engine configuration specifying engine-specific options such as parallelism level.

server

val server: Server

Jetty server instance being configuring and starting

Functions

start

fun start(wait: Boolean): JettyApplicationEngine

Starts this ApplicationEngine

stop

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

Stops this ApplicationEngine

Inherited Functions

toString

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