JettyApplicationEngineBase

open class JettyApplicationEngineBase : BaseApplicationEngine

ApplicationEngine base type for running in a standalone Jetty

Types

Configuration

class Configuration : Configuration

Jetty-specific engine configuration

Constructors

<init>

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

ApplicationEngine base type for running in a standalone Jetty

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

Inherited Properties

environment

instance of ApplicationEngineEnvironment for this engine

pipeline

val pipeline: EnginePipeline

pipeline to use with this engine

Functions

start

open fun start(wait: Boolean): JettyApplicationEngineBase

Starts this ApplicationEngine

stop

open fun stop(
    gracePeriodMillis: Long,
    timeoutMillis: Long
): Unit

Stops this ApplicationEngine

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.

stop

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

Stops this ApplicationEngine

stopServerOnCancellation

fun ApplicationEngine.stopServerOnCancellation(): CompletableJob

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

Inheritors

JettyApplicationEngine

class JettyApplicationEngine : JettyApplicationEngineBase

ApplicationEngine implementation for running in a standalone Jetty