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

Package-level declarations

Types

class Application : ApplicationCallPipeline, CoroutineScope

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.

ApplicationCall

interface ApplicationCall : CoroutineScope

A single act of communication between a client and server.

ApplicationCallPipeline

open class ApplicationCallPipeline(val developmentMode: Boolean = false, val environment: ApplicationEnvironment) : Pipeline<Unit, PipelineCall>

Pipeline configuration for executing PipelineCall instances.

ApplicationEnvironment

expect interface ApplicationEnvironment

Represents an environment in which Application runs

actual interface ApplicationEnvironment

Represents an environment in which Application runs

actual interface ApplicationEnvironment

ApplicationEvents

typealias ~~ApplicationEvents~~ = Events

Provides events for Application lifecycle.

ApplicationPlugin

interface ApplicationPlugin<out TConfiguration : Any> : BaseApplicationPlugin<Application, TConfiguration, PluginInstance>

Defines a Plugin that is installed into Application.

BaseApplicationPlugin

interface BaseApplicationPlugin<in TPipeline : Pipeline<*, PipelineCall>, out TConfiguration : Any, TPlugin : Any> : Plugin<TPipeline, TConfiguration, TPlugin>

Defines a Plugin that is installed into Application.

BaseRouteScopedPlugin

interface BaseRouteScopedPlugin<TConfiguration : Any, TPlugin : Any> : Plugin<ApplicationCallPipeline, TConfiguration, TPlugin>

Defines a Plugin that can be installed into a RoutingNode.

CallContext

open class CallContext<PluginConfig : Any>

The context associated with the call that is currently being processed by server. Every call handler (PluginBuilder.onCall, PluginBuilder.onCallReceive, PluginBuilder.onCallRespond, and so on) of your plugin has a derivative of CallContext as a receiver.

DuplicateApplicationPluginException

open class ~~DuplicateApplicationPluginException~~(message: String) : Exception

Thrown on an attempt to install the plugin with the same key as for the already installed plugin.

DuplicatePluginException

class DuplicatePluginException(message: String) : DuplicateApplicationPluginException

Thrown on an attempt to install the plugin with the same key as for the already installed plugin.

EventDefinition

typealias ~~EventDefinition<T>~~ = io.ktor.events.EventDefinition<T>

Definition of an event. Event is used as a key so both hashCode and equals need to be implemented properly. Inheriting of this class is an experimental plugin. Instantiate directly if inheritance not necessary.

EventHandler

typealias ~~EventHandler<T>~~ = io.ktor.events.EventHandler<T>

Specifies signature for the event handler.

Hook

interface Hook<HookHandler>

A hook that can be registered in PluginBuilder.

InvalidBodyException

class InvalidBodyException(message: String) : Exception

An exception that is thrown when the current body in the HTTP pipeline is invalid.

MissingApplicationPluginException

class MissingApplicationPluginException(val key: AttributeKey<*>) : IllegalStateException, CopyableThrowable<MissingApplicationPluginException>

Thrown on an attempt to access the plugin that is not yet installed.

OnCallContext

class OnCallContext<PluginConfig : Any> : CallContext<PluginConfig>

A context associated with the call handling by your application. OnCallContext is a receiver for PluginBuilder.onCall handler of your PluginBuilder.

OnCallReceiveContext

class OnCallReceiveContext<PluginConfig : Any> : CallContext<PluginConfig>

A context associated with the call.receive() action. Allows you to transform the received body. OnCallReceiveContext is a receiver for PluginBuilder.onCallReceive handler of your PluginBuilder.

OnCallRespondContext

class OnCallRespondContext<PluginConfig : Any> : CallContext<PluginConfig>

A context associated with the call.respond() action. Allows you to transform the response body. OnCallRespondContext is a receiver for PluginBuilder.onCallRespond handler of your PluginBuilder.

PipelineCall

interface PipelineCall : ApplicationCall

A single act of communication between a client and server.

Plugin

interface Plugin<in TPipeline : Pipeline<*, PipelineCall>, out TConfiguration : Any, TPlugin : Any>

Defines an installable Plugin.

PluginBuilder

abstract class PluginBuilder<PluginConfig : Any>

A utility class to build an ApplicationPlugin instance.

PluginInstance

class PluginInstance

An instance of the plugin installed to your application.

RouteScopedPlugin

interface RouteScopedPlugin<TConfiguration : Any> : BaseRouteScopedPlugin<TConfiguration, PluginInstance>

Defines a Plugin that can be installed into RoutingNode

RouteScopedPluginBuilder

abstract class RouteScopedPluginBuilder<PluginConfig : Any>(key: AttributeKey<PluginInstance>) : PluginBuilder<PluginConfig>

Utility class to build a RouteScopedPlugin instance.

ServerConfig

class ServerConfig

Core configuration for a running server. Contains modules, paths, and environment details.

ServerConfigBuilder

class ServerConfigBuilder(val environment: ApplicationEnvironment)

A builder for ServerConfig.

TransformBodyContext

class TransformBodyContext(val requestedType: TypeInfo?)

Contains type information about the current request or response body when performing a transformation.

Properties

application

val PipelineContext<*, PipelineCall>.application: Application

Current application for the context

ApplicationStarted

val ApplicationStarted: EventDefinition<Application>

Event definition for Application Started event

ApplicationStarting

val ApplicationStarting: EventDefinition<Application>

Event definition for Application Starting event

ApplicationStopped

val ApplicationStopped: EventDefinition<Application>

Event definition for Application Stopped event

ApplicationStopping

val ApplicationStopping: EventDefinition<Application>

Event definition for Application Stopping event

ApplicationStopPreparing

val ApplicationStopPreparing: EventDefinition<ApplicationEnvironment>

Event definition for an event that is fired when the application is going to stop

call

val <C : ApplicationCall> PipelineContext<*, C>.call: C

Convenience extension property for pipeline interceptors with Application call contexts.

val PipelineContext<*, PipelineCall>.call: PipelineCall

Current call for the context

host

val ApplicationConfig.host: String

The host address of the currently running application, as defined by the configuration at start-up.

isHandled

val ApplicationCall.isHandled: Boolean

Indicates if a response is sent.

log

val Application.log: Logger

Convenience property to access log from application

pluginRegistry

val <A : Pipeline<*, PipelineCall>> A.pluginRegistry: Attributes

Returns the existing plugin registry or registers and returns a new one.

port

val ApplicationConfig.port: Int

The port the current application is running on, as defined by the configuration at start-up.

receiveType

var ApplicationCall.receiveType: TypeInfo

The TypeInfo recorded from the last call.receive() call.

ServerReady

val ServerReady: EventDefinition<ApplicationEnvironment>

Fired when the server is ready to accept connections

Functions

createApplicationPlugin

fun createApplicationPlugin(name: String, body: PluginBuilder<Unit>.() -> Unit): ApplicationPlugin<Unit>

fun <PluginConfigT : Any> createApplicationPlugin(name: String, createConfiguration: () -> PluginConfigT, body: PluginBuilder<PluginConfigT>.() -> Unit): ApplicationPlugin<PluginConfigT>

fun <PluginConfigT : Any> createApplicationPlugin(name: String, configurationPath: String, createConfiguration: (config: ApplicationConfig) -> PluginConfigT, body: PluginBuilder<PluginConfigT>.() -> Unit): ApplicationPlugin<PluginConfigT>

Creates an ApplicationPlugin that can be installed into an Application.

createRouteScopedPlugin

fun createRouteScopedPlugin(name: String, body: RouteScopedPluginBuilder<Unit>.() -> Unit): RouteScopedPlugin<Unit>

fun <PluginConfigT : Any> createRouteScopedPlugin(name: String, createConfiguration: () -> PluginConfigT, body: RouteScopedPluginBuilder<PluginConfigT>.() -> Unit): RouteScopedPlugin<PluginConfigT>

fun <PluginConfigT : Any> createRouteScopedPlugin(name: String, configurationPath: String, createConfiguration: (config: ApplicationConfig) -> PluginConfigT, body: RouteScopedPluginBuilder<PluginConfigT>.() -> Unit): RouteScopedPlugin<PluginConfigT>

Creates a RouteScopedPlugin that can be installed into a io.ktor.server.routing.RoutingNode.

findPluginInRoute

fun <F : Any> RoutingNode.findPluginInRoute(plugin: Plugin<*, *, F>): F?

Finds the plugin F in the current RoutingNode. If not found, search in the parent RoutingNode.

install

fun <P : RoutingNode, B : Any, F : Any> P.~~install~~(plugin: BaseApplicationPlugin<P, B, F>, configure: B.() -> Unit = {}): F

fun <P : Pipeline<*, PipelineCall>, B : Any, F : Any> P.install(plugin: Plugin<P, B, F>, configure: B.() -> Unit = {}): F

Installs a plugin into this pipeline, if it is not yet installed.

plugin

fun <A : Pipeline<*, PipelineCall>, F : Any> A.plugin(plugin: Plugin<*, *, F>): F

Gets a plugin instance for this pipeline, or fails with MissingApplicationPluginException if the plugin is not installed.

pluginOrNull

fun <A : Pipeline<*, PipelineCall>, F : Any> A.pluginOrNull(plugin: Plugin<*, *, F>): F?

Returns a plugin instance for this pipeline, or null if the plugin is not installed.

serverConfig

fun serverConfig(environment: ApplicationEnvironment = applicationEnvironment {}, block: ServerConfigBuilder.() -> Unit = {}): ServerConfig

Creates an ServerConfig instance.

uninstall

fun <A : Pipeline<*, PipelineCall>, B : Any, F : Any> A.~~uninstall~~(plugin: Plugin<A, B, F>)

Uninstalls a plugin from the pipeline.

uninstallAllPlugins

fun <A : Pipeline<*, PipelineCall>> A.~~uninstallAllPlugins~~()

Uninstalls all plugins from the pipeline.

uninstallPlugin

fun <A : Pipeline<*, PipelineCall>, F : Any> A.~~uninstallPlugin~~(key: AttributeKey<F>)

Uninstalls a plugin specified by key from the pipeline.