TomcatApplicationEngine

class TomcatApplicationEngine : BaseApplicationEngine

Tomcat application engine that runs it in embedded mode

Types

Configuration

class Configuration : Configuration

Tomcat engine specific configuration builder

Constructors

<init>

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

Tomcat application engine that runs it in embedded mode

Inherited Properties

environment

instance of ApplicationEngineEnvironment for this engine

pipeline

val pipeline: EnginePipeline

pipeline to use with this engine

Functions

start

fun start(wait: Boolean): TomcatApplicationEngine

Starts this ApplicationEngine

stop

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

Stops this ApplicationEngine

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.