ktor-server-core/io.ktor.server.application/Application

Application

class Application : ApplicationCallPipeline, CoroutineScope(source)

Represents configured and running web application, capable of handling requests. It is also the application coroutine scope that is cancelled immediately at application stop so useful for launching background coroutines.

Report a problem

Properties

attributes

val attributes: Attributes

coroutineContext

open override val coroutineContext: CoroutineContext

developmentMode

override val developmentMode: Boolean = false

engine

val engine: ApplicationEngine

environment

val environment: ApplicationEnvironment

isEmpty

val isEmpty: Boolean

items

val items: List<PipelinePhase>

log

val Application.log: Logger

Convenience property to access log from application

mdcProvider

val Application.mdcProvider: MDCProvider

Returns first instance of a plugin that implements MDCProvider or default implementation with an empty context

monitor

val monitor: Events

parentCoroutineContext

val parentCoroutineContext: CoroutineContext

receivePipeline

val receivePipeline: ApplicationReceivePipeline

Pipeline for receiving content

rootPath

var rootPath: String

routingRoot

val Application.routingRoot: RoutingNode

Gets the root of the routing block.

sendPipeline

val sendPipeline: ApplicationSendPipeline

Pipeline for sending content

Functions

addPhase

fun addPhase(phase: PipelinePhase)

afterIntercepted

open fun afterIntercepted()

dispose

fun ~~dispose~~()

Cancels the application job without waiting for join.

disposeAndJoin

suspend fun disposeAndJoin()

Called by ApplicationEngine when Application is terminated.

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: suspend 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: suspend Application.() -> Unit): EmbeddedServer<TEngine, TConfiguration>

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

execute

suspend fun execute(context: PipelineCall, subject: Unit)

insertPhaseAfter

fun insertPhaseAfter(reference: PipelinePhase, phase: PipelinePhase)

insertPhaseBefore

fun insertPhaseBefore(reference: PipelinePhase, phase: PipelinePhase)

intercept

fun intercept(phase: PipelinePhase, block: PipelineInterceptor<Unit, PipelineCall>)

interceptorsForPhase

fun interceptorsForPhase(phase: PipelinePhase): List<PipelineInterceptor<Unit, PipelineCall>>

merge

fun merge(from: Pipeline<Unit, PipelineCall>)

mergePhases

fun mergePhases(from: Pipeline<Unit, PipelineCall>)

property

inline fun <E> Application.property(key: String): E

Convenience function for accessing properties using serialization.

propertyOrNull

inline fun <E> Application.propertyOrNull(key: String): E?

Convenience function for accessing properties using serialization.

resetFrom

fun resetFrom(from: Pipeline<Unit, PipelineCall>)

routing

fun Application.routing(configuration: Routing.() -> Unit): RoutingRoot

Installs a RoutingRoot plugin for the this Application and runs a configuration script on it. You can learn more about routing in Ktor from Routing.

toString

open override fun toString(): String