ktor-server-host-common/io.ktor.server.engine

Package-level declarations

Types

ApplicationEngine

interface ApplicationEngine

An engine which runs an application.

ApplicationEngineEnvironment

interface ApplicationEngineEnvironment : ApplicationEnvironment

Represents an environment in which engine runs.

ApplicationEngineEnvironmentBuilder

expect class ApplicationEngineEnvironmentBuilder

Engine environment configuration builder

actual class ApplicationEngineEnvironmentBuilder

Engine environment configuration builder

actual class ApplicationEngineEnvironmentBuilder

Engine environment configuration builder

ApplicationEngineEnvironmentReloading

class ApplicationEngineEnvironmentReloading(val classLoader: ClassLoader, val log: Logger, val config: ApplicationConfig, val connectors: List<EngineConnectorConfig>, modules: List<Application.() -> Unit>, watchPaths: List<String> = emptyList(), parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, val rootPath: String = "", val developmentMode: Boolean = true) : ApplicationEngineEnvironment

Implements ApplicationEngineEnvironment by loading an Application from a folder or jar.

ApplicationEngineFactory

interface ApplicationEngineFactory<out TEngine : ApplicationEngine, TConfiguration : ApplicationEngine.Configuration>

Factory interface for creating ApplicationEngine instances

BaseApplicationCall

abstract class BaseApplicationCall(val application: Application) : ApplicationCall

Base class for implementing an ApplicationCall.

BaseApplicationEngine

abstract class BaseApplicationEngine(val environment: ApplicationEngineEnvironment, val pipeline: EnginePipeline = defaultEnginePipeline(environment)) : ApplicationEngine

Base class for implementing ApplicationEngine

BaseApplicationRequest

abstract class BaseApplicationRequest(val call: ApplicationCall) : ApplicationRequest

Base class for implementing ApplicationRequest

BaseApplicationResponse

abstract class BaseApplicationResponse(val call: ApplicationCall) : ApplicationResponse

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.

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, ApplicationCall>

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) : EngineConnectorBuilder, EngineSSLConnectorConfig

Mutable implementation of EngineSSLConnectorConfig for building connectors programmatically

EngineSSLConnectorConfig

interface EngineSSLConnectorConfig : EngineConnectorConfig

Represents an SSL connector configuration.

NativeApplicationEngineEnvironment

class NativeApplicationEngineEnvironment(val log: Logger, val config: ApplicationConfig, val connectors: MutableList<EngineConnectorConfig>, modules: MutableList<Application.() -> Unit>, val parentCoroutineContext: CoroutineContext, val rootPath: String, val developmentMode: Boolean) : ApplicationEngineEnvironment

ShutDownUrl

class ShutDownUrl(val url: String, val exitCode: ApplicationCall.() -> 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

expect fun ApplicationEngine.addShutdownHook(stop: () -> Unit)

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

actual fun ApplicationEngine.addShutdownHook(stop: () -> 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.

actual fun ApplicationEngine.addShutdownHook(stop: () -> Unit)

applicationEngineEnvironment

fun applicationEngineEnvironment(builder: ApplicationEngineEnvironmentBuilder.() -> Unit): ApplicationEngineEnvironment

Creates ApplicationEngineEnvironment using ApplicationEngineEnvironmentBuilder.

commandLineEnvironment

fun commandLineEnvironment(args: Array<String>): ApplicationEngineEnvironment

Creates an ApplicationEngineEnvironment instance from command line arguments

fun commandLineEnvironment(args: Array<String>, environmentBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {}): ApplicationEngineEnvironment

Creates an ApplicationEngineEnvironment instance from command line arguments

connector

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

Adds a non-secure connector to this engine environment

defaultEnginePipeline

fun defaultEnginePipeline(environment: ApplicationEnvironment): 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>, environment: ApplicationEngineEnvironment, configure: TConfiguration.() -> Unit = {}): TEngine

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), configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit): TEngine

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, configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit): TEngine

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

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

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

handleFailure

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

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 the parent job is cancelled or a returned deferred is cancelled. It is important to complete or cancel returned deferred otherwise the parent job will be unable to complete successfully.

loadCommonConfiguration