abstract class BaseApplicationEngine(val environment: ApplicationEnvironment, monitor: Events, developmentMode: Boolean, val pipeline: EnginePipeline = defaultEnginePipeline(environment.config, developmentMode)) : ApplicationEngine

Base class for implementing ApplicationEngine

BaseApplicationRequest

abstract class BaseApplicationRequest(val call: PipelineCall) : PipelineRequest

Base class for implementing PipelineRequest

BaseApplicationResponse

abstract class BaseApplicationResponse(val call: PipelineCall) : PipelineResponse

CommandLineConfig

class CommandLineConfig(val rootConfig: ServerConfig, val engineConfig: BaseApplicationEngine.Configuration)

ConfigKeys

object ConfigKeys

ConnectorType

data class ConnectorType(val name: String)

Represents a type of a connector, e.g HTTP or HTTPS.

DefaultUncaughtExceptionHandler

class DefaultUncaughtExceptionHandler(logger: () -> Logger) : CoroutineExceptionHandler

Handles all uncaught exceptions and logs errors with the specified logger ignoring CancellationException and IOException.

EmbeddedServer

expect class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit = {})

Represents an embedded server that hosts an application. It's an entry point to the application and handles the lifecycle of the application engine.

actual class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>(rootConfig: ServerConfig, engineFactory: ApplicationEngineFactory<TEngine, TConfiguration>, engineConfigBlock: TConfiguration.() -> Unit)

actual class EmbeddedServer<TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>

EngineConnectorBuilder

open class EngineConnectorBuilder(val type: ConnectorType = ConnectorType.HTTP) : EngineConnectorConfig

Mutable implementation of EngineConnectorConfig for building connectors programmatically

EngineConnectorConfig

interface EngineConnectorConfig

Represents a connector configuration.

EnginePipeline

class EnginePipeline(val developmentMode: Boolean = false) : Pipeline<Unit, PipelineCall>

Application engine pipeline. One usually don't need to install interceptors here unless your are writing your own engine implementation

EngineSSLConnectorBuilder

class EngineSSLConnectorBuilder(var keyStore: KeyStore, var keyAlias: String, var keyStorePassword: () -> CharArray, var privateKeyPassword: () -> CharArray) : EngineSSLConnectorConfig

Mutable implementation of EngineSSLConnectorConfig for building connectors programmatically

EngineSSLConnectorConfig

interface EngineSSLConnectorConfig

Represents an SSL connector configuration.

ShutDownUrl

class ShutDownUrl(val url: String, val exitCode: <Error class: unknown class>.() -> Int)

A plugin that allows you to configure a URL used to shut down the server. There are two ways to enable this plugin:

Functions

addShutdownHook

fun EmbeddedServer<*, *>.addShutdownHook(stop: () -> Unit)

Adds automatic application shutdown hooks management. Should be used before starting the server. Once application 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.

applicationEnvironment

fun applicationEnvironment(block: ApplicationEnvironmentBuilder.() -> Unit = {}): ApplicationEnvironment

CommandLineConfig

fun CommandLineConfig(args: Array<String>): CommandLineConfig

Creates an ApplicationEnvironment instance from command line arguments

connector

inline fun ApplicationEngine.Configuration.connector(builder: EngineConnectorBuilder.() -> Unit)

Adds a non-secure connector to this engine environment

defaultEnginePipeline

fun defaultEnginePipeline(config: ApplicationConfig, developmentMode: Boolean): EnginePipeline

Default engine pipeline for all engines. Use it only if you are writing your own application engine implementation.

defaultExceptionStatusCode

fun defaultExceptionStatusCode(cause: Throwable): HttpStatusCode?

Map cause to the corresponding status code or null if no default exception mapping for this cause type

embeddedServer

fun <TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, rootConfig: ServerConfig, configure: TConfiguration.() -> Unit = {}): EmbeddedServer<TEngine, TConfiguration>

Creates an embedded server with the given factory, environment and configure script.

fun <TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, environment: ApplicationEnvironment = applicationEnvironment(), configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit = {}): EmbeddedServer<TEngine, TConfiguration>

Creates an embedded server with the given factory, environment and configure script.

fun <TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = listOf(WORKING_DIRECTORY_PATH), module: Application.() -> Unit): EmbeddedServer<TEngine, TConfiguration>

Creates an embedded server with the given factory, listening on host:port.

embeddedServer

fun <TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration> CoroutineScope.embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, vararg connectors: EngineConnectorConfig = arrayOf(), watchPaths: List<String> = listOf(WORKING_DIRECTORY_PATH), parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, module: Application.() -> Unit): EmbeddedServer<TEngine, TConfiguration>

Creates an embedded server with the given factory, listening on given connectors.

fun <TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration> CoroutineScope.embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = listOf(WORKING_DIRECTORY_PATH), parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, module: Application.() -> Unit): EmbeddedServer<TEngine, TConfiguration>

Creates an embedded server with the given factory, listening on host:port.

handleFailure

suspend fun handleFailure(call: ApplicationCall, error: Throwable)

Logs the error and responds with an appropriate error status code.

installDefaultTransformations

fun ApplicationReceivePipeline.installDefaultTransformations()

Default receive transformation

fun ApplicationSendPipeline.installDefaultTransformations()

Default send transformation

launchOnCancellation

fun Job.launchOnCancellation(block: suspend () -> Unit): CompletableJob

Launch a coroutine with block body when either the parent job or the returned job is cancelled. It is important to complete or cancel the returned CompletableJob otherwise the parent job will be unable to complete successfully.

loadCommonConfiguration

fun ApplicationEngine.Configuration.loadCommonConfiguration(deploymentConfig: ApplicationConfig)

Loads common engine configuration parameters applicable to all engine types from the specified ApplicationConfig.

logError

suspend fun logError(call: ApplicationCall, error: Throwable)

Logs the error with MDC setup.

sslConnector

inline fun <Error class: unknown class>.sslConnector(keyStore: KeyStore, keyAlias: String, noinline keyStorePassword: () -> CharArray, noinline privateKeyPassword: () -> CharArray, builder: EngineSSLConnectorBuilder.() -> Unit)

Adds a secure connector to this engine environment

stop

fun <Error class: unknown class>.stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit)

Stops this ApplicationEngine

stopServerOnCancellation

fun ApplicationEngine.stopServerOnCancellation(application: Application, gracePeriodMillis: Long = 50, timeoutMillis: Long = 5000): CompletableJob

Stop server on job cancellation. The returned CompletableJob needs to be completed or cancelled.

withPort

expect fun EngineConnectorConfig.withPort(otherPort: Int): EngineConnectorConfig

Returns new instance of EngineConnectorConfig based on this with modified port

actual fun EngineConnectorConfig.withPort(otherPort: Int): EngineConnectorConfig

Returns new instance of EngineConnectorConfig based on this with modified port

actual fun EngineConnectorConfig.withPort(otherPort: Int): EngineConnectorConfig

Returns new instance of EngineConnectorConfig based on this with modified port