ktor-server-core

alltypes

typealias AcceptHeaderContributor = (call: ApplicationCall, acceptedContentTypes: List<ContentTypeWithQuality>) -> List<ContentTypeWithQuality>
data class AndRouteSelector : RouteSelector

AndRouteSelector(first: RouteSelector, second: RouteSelector)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val first: RouteSelector
val second: RouteSelector
fun toString(): String

class Application : ApplicationCallPipeline, CoroutineScope

Application(environment: ApplicationEnvironment)
val coroutineContext: <ERROR CLASS>
fun dispose(): Unit
val environment: ApplicationEnvironment

interface ApplicationCall

abstract val application: Application
abstract val attributes: Attributes
abstract val parameters: Parameters
abstract val request: ApplicationRequest
abstract val response: ApplicationResponse

open class ApplicationCallPipeline : Pipeline<Unit, ApplicationCall>

ApplicationCallPipeline(developmentMode: Boolean = false)
val Call: PipelinePhase
val Fallback: PipelinePhase
val Features: PipelinePhase
val Monitoring: PipelinePhase
val Setup: PipelinePhase
val developmentMode: Boolean
val receivePipeline: ApplicationReceivePipeline
val sendPipeline: ApplicationSendPipeline

interface ApplicationConfig

abstract fun config(path: String): ApplicationConfig
abstract fun configList(path: String): List<ApplicationConfig>
abstract fun property(path: String): ApplicationConfigValue
abstract fun propertyOrNull(path: String): ApplicationConfigValue?

interface ApplicationConfigValue

abstract fun getList(): List<String>
abstract fun getString(): String

class ApplicationConfigurationException : Exception

ApplicationConfigurationException(message: String)

interface ApplicationEnvironment

abstract val classLoader: ClassLoader
abstract val config: ApplicationConfig
abstract val developmentMode: Boolean
abstract val log: Logger
abstract val monitor: ApplicationEvents
abstract val parentCoroutineContext: <ERROR CLASS>
abstract val rootPath: String

class ApplicationEvents

ApplicationEvents()
fun <T> raise(definition: EventDefinition<T>, value: T): Unit
fun <T> subscribe(definition: EventDefinition<T>, handler: EventHandler<T>): DisposableHandle
fun <T> unsubscribe(definition: EventDefinition<T>, handler: EventHandler<T>): Unit

interface ApplicationFeature<in TPipeline : Pipeline<*, ApplicationCall>, out TConfiguration : Any, TFeature : Any>

abstract fun install(pipeline: TPipeline, configure: TConfiguration.() -> Unit): TFeature
abstract val key: AttributeKey<TFeature>

open class ApplicationReceivePipeline : Pipeline<ApplicationReceiveRequest, ApplicationCall>

ApplicationReceivePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val Transform: PipelinePhase
open val developmentMode: Boolean

class ApplicationReceiveRequest

ApplicationReceiveRequest(type: KClass<*>, value: Any)
ApplicationReceiveRequest(typeInfo: KType, value: Any, reusableValue: Boolean = false)
val reusableValue: Boolean
val type: KClass<*>
val typeInfo: KType
val value: Any

interface ApplicationRequest

abstract val call: ApplicationCall
abstract val cookies: RequestCookies
abstract val headers: Headers
abstract val local: RequestConnectionPoint
abstract val pipeline: ApplicationReceivePipeline
abstract val queryParameters: Parameters
abstract fun receiveChannel(): ByteReadChannel

interface ApplicationResponse

abstract val call: ApplicationCall
abstract val cookies: ResponseCookies
abstract val headers: ResponseHeaders
abstract val pipeline: ApplicationSendPipeline
abstract fun push(builder: ResponsePushBuilder): Unit
abstract fun status(): HttpStatusCode?
abstract fun status(value: HttpStatusCode): Unit

open class ApplicationSendPipeline : Pipeline<Any, ApplicationCall>

ApplicationSendPipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val ContentEncoding: PipelinePhase
val Engine: PipelinePhase
val Render: PipelinePhase
val TransferEncoding: PipelinePhase
val Transform: PipelinePhase
open val developmentMode: Boolean

object AutoHeadResponse : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>

fun install(pipeline: ApplicationCallPipeline, configure: Unit.() -> Unit): Unit
val key: AttributeKey<Unit>

open class BadRequestException : Exception

BadRequestException(message: String, cause: Throwable? = null)

class CORS

CORS(configuration: Configuration)
const val CORS_DEFAULT_MAX_AGE: Long
class Configuration

Configuration()
val CorsDefaultHeaders: Set<String>
val CorsDefaultMethods: Set<HttpMethod>
val CorsSimpleContentTypes: Set<ContentType>
val CorsSimpleRequestHeaders: Set<String>
val CorsSimpleResponseHeaders: Set<String>
var allowCredentials: Boolean
fun allowHeaders(predicate: (String) -> Boolean): Unit
fun allowHeadersPrefixed(headerPrefix: String): Unit
var allowNonSimpleContentTypes: Boolean
var allowSameOrigin: Boolean
fun allowXHttpMethodOverride(): Unit
fun anyHost(): Unit
fun exposeHeader(header: String): Unit
fun exposeXHttpMethodOverride(): Unit
val exposedHeaders: MutableSet<String>
fun header(header: String): Unit
val headerPredicates: MutableList<(String) -> Boolean>
val headers: MutableSet<String>
fun host(host: String, schemes: List<String> = listOf("http"), subDomains: List<String> = emptyList()): Unit
val hosts: MutableSet<String>
var maxAge: Duration
var maxAgeInSeconds: Long
fun method(method: HttpMethod): Unit
val methods: MutableSet<HttpMethod>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CORS>

const val CORS_DEFAULT_MAX_AGE: Long
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CORS
val key: AttributeKey<CORS>

val allHeaders: Set<String>
val allHeadersSet: Set<String>
val allowCredentials: Boolean
val allowSameOrigin: Boolean
val allowsAnyHost: Boolean
val headerPredicates: List<(String) -> Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CORS
suspend fun intercept(context: PipelineContext<Unit, ApplicationCall>): Unit
val key: AttributeKey<CORS>
val methods: Set<HttpMethod>

sealed class CachedTransformationResult<T : Any>

open class Failure : CachedTransformationResult<Nothing>

Failure(type: KType, cause: Throwable)
val cause: Throwable

class Success<T : Any> : CachedTransformationResult<T>

Success(type: KType, value: T)
val value: T

val type: KType

class CachingHeaders

CachingHeaders(optionsProviders: List<(OutgoingContent) -> CachingOptions?>)
class Configuration

Configuration()
fun options(provider: (OutgoingContent) -> CachingOptions?): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CachingHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CachingHeaders
val key: AttributeKey<CachingHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CachingHeaders
val key: AttributeKey<CachingHeaders>
fun optionsFor(content: OutgoingContent): List<CachingOptions>

class CallId

class Configuration

Configuration()
fun generate(block: CallIdProvider): Unit
fun header(headerName: String): Unit
fun reply(block: (call: ApplicationCall, callId: String) -> Unit): Unit
fun replyToHeader(headerName: String): Unit
fun retrieve(block: CallIdProvider): Unit
fun retrieveFromHeader(headerName: String): Unit
fun verify(predicate: CallIdVerifier): Unit
fun verify(dictionary: String, reject: Boolean = false): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CallId>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CallId
val key: AttributeKey<CallId>
val phase: PipelinePhase

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CallId
val key: AttributeKey<CallId>
val phase: PipelinePhase

typealias CallIdProvider = (call: ApplicationCall) -> String?
typealias CallIdVerifier = (String) -> Boolean
class CallLogging

class Configuration

Configuration()
fun filter(predicate: (ApplicationCall) -> Boolean): Unit
fun format(formatter: (ApplicationCall) -> String): Unit
var level: Level
var logger: Logger?
fun mdc(name: String, provider: (ApplicationCall) -> String?): Unit

companion object Feature : ApplicationFeature<Application, Configuration, CallLogging>

fun install(pipeline: Application, configure: Configuration.() -> Unit): CallLogging
val key: AttributeKey<CallLogging>

object Internals

suspend fun <C : PipelineContext<*, ApplicationCall>> C.withMDCBlock(block: suspend C.() -> Unit): Unit
suspend fun withMDCBlock(call: ApplicationCall, block: suspend () -> Unit): Unit

fun install(pipeline: Application, configure: Configuration.() -> Unit): CallLogging
val key: AttributeKey<CallLogging>

enum class CompressedFileType

BROTLI
GZIP
val encoding: String
val extension: String
fun file(plain: File): File

class Compression

Compression(compression: Configuration)
class Configuration : ConditionsHolderBuilder

Configuration()
fun build(): CompressionOptions
val conditions: MutableList<ApplicationCall.(OutgoingContent) -> Boolean>
fun default(): Unit
fun encoder(name: String, encoder: CompressionEncoder, block: CompressionEncoderBuilder.() -> Unit = {}): Unit
val encoders: MutableMap<String, CompressionEncoderBuilder>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Compression>

val SuppressionAttribute: AttributeKey<Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Compression
val key: AttributeKey<Compression>

val SuppressionAttribute: AttributeKey<Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Compression
val key: AttributeKey<Compression>

interface CompressionEncoder

abstract fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS> = Dispatchers.Unconfined): ByteReadChannel
abstract fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS> = Dispatchers.Unconfined): ByteWriteChannel
open fun predictCompressedLength(originalLength: Long): Long?

class CompressionEncoderBuilder : ConditionsHolderBuilder

fun build(): CompressionEncoderConfig
val conditions: ArrayList<ApplicationCall.(OutgoingContent) -> Boolean>
val encoder: CompressionEncoder
val name: String
var priority: Double

data class CompressionEncoderConfig

CompressionEncoderConfig(name: String, encoder: CompressionEncoder, conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>, priority: Double)
val conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>
val encoder: CompressionEncoder
val name: String
val priority: Double

data class CompressionOptions

CompressionOptions(encoders: Map<String, CompressionEncoderConfig> = emptyMap(), conditions: List<ApplicationCall.(OutgoingContent) -> Boolean> = emptyList())
val conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>
val encoders: Map<String, CompressionEncoderConfig>

class ConditionalHeaders

ConditionalHeaders(versionProviders: List<suspend (OutgoingContent) -> List<Version>>)
class Configuration

Configuration()
fun version(provider: suspend (OutgoingContent) -> List<Version>): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ConditionalHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ConditionalHeaders
val key: AttributeKey<ConditionalHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ConditionalHeaders
val key: AttributeKey<ConditionalHeaders>
suspend fun versionsFor(content: OutgoingContent): List<Version>

interface ConditionsHolderBuilder

abstract val conditions: MutableList<ApplicationCall.(OutgoingContent) -> Boolean>

data class ConstantParameterRouteSelector : RouteSelector

ConstantParameterRouteSelector(name: String, value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String
val value: String

interface ContentConverter

abstract suspend fun convertForReceive(context: PipelineContext<ApplicationReceiveRequest, ApplicationCall>): Any?
abstract suspend fun convertForSend(context: PipelineContext<Any, ApplicationCall>, contentType: ContentType, value: Any): Any?

class ContentNegotiation

ContentNegotiation(registrations: List<ConverterRegistration>, acceptContributors: List<AcceptHeaderContributor>)
class Configuration

Configuration()
fun accept(contributor: AcceptHeaderContributor): Unit
var checkAcceptHeaderCompliance: Boolean
fun <T : ContentConverter> register(contentType: ContentType, converter: T, configuration: T.() -> Unit = {}): Unit

data class ConverterRegistration

ConverterRegistration(contentType: ContentType, converter: ContentConverter)
val contentType: ContentType
val converter: ContentConverter

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ContentNegotiation>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ContentNegotiation
val key: AttributeKey<ContentNegotiation>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ContentNegotiation
val key: AttributeKey<ContentNegotiation>
val registrations: List<ConverterRegistration>

abstract class ContentTransformationException : Exception

ContentTransformationException(message: String)

typealias ContentTransformationException = ContentTransformationException
data class ContentTypeWithQuality

ContentTypeWithQuality(contentType: ContentType, quality: Double = 1.0)
val contentType: ContentType
val quality: Double

interface ConversionService

abstract fun fromValues(values: List<String>, type: Type): Any?
abstract fun toValues(value: Any?): List<String>

class CookieConfiguration

CookieConfiguration()
var domain: String?
var duration: TemporalAmount?
var encoding: CookieEncoding
val extensions: MutableMap<String, String?>
var httpOnly: Boolean
var maxAgeInSeconds: Long
var path: String?
var secure: Boolean

class CookieIdSessionBuilder<S : Any> : CookieSessionBuilder<S>

CookieIdSessionBuilder(type: KClass<S>)
fun identity(f: () -> String): Unit
var sessionIdProvider: () -> String

open class CookieSessionBuilder<S : Any>

CookieSessionBuilder(type: KClass<S>)
val cookie: CookieConfiguration
var serializer: SessionSerializer<S>
fun transform(transformer: SessionTransportTransformer): Unit
val transformers: List<SessionTransportTransformer>
val type: KClass<S>
val typeInfo: KType

class CopyOnWriteHashMap<K : Any, V : Any>

CopyOnWriteHashMap()
fun computeIfAbsent(key: K, producer: (key: K) -> V): V
operator fun get(key: K): V?
fun put(key: K, value: V): V?
fun remove(key: K): V?
operator fun set(key: K, value: V): Unit

interface CurrentSession

abstract fun clear(name: String): Unit
abstract fun findName(type: KClass<*>): String
abstract fun get(name: String): Any?
abstract fun set(name: String, value: Any?): Unit

class DataConversion : ConversionService

DataConversion(converters: Map<Type, ConversionService>)
class Configuration

Configuration()
fun convert(klass: KClass<*>, convertor: ConversionService): Unit
fun convert(ktype: KType, convertor: ConversionService): Unit
fun convert(klass: KClass<*>, configure: DelegatingConversionService.() -> Unit): Unit
inline fun <reified T> convert(noinline configure: DelegatingConversionService.() -> Unit): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, DataConversion>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): DataConversion
val key: AttributeKey<DataConversion>

fun fromValues(values: List<String>, type: Type): Any?
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): DataConversion
val key: AttributeKey<DataConversion>
fun toValues(value: Any?): List<String>

class DataConversionException : DataConversionException

DataConversionException(message: String = "Invalid data format")

object DefaultConversionService : ConversionService

fun fromValues(values: List<String>, type: Type): Any
fun toValues(value: Any?): List<String>

class DefaultHeaders

DefaultHeaders(config: Configuration)
class Configuration

Configuration()
var clock: () -> Long
fun header(name: String, value: String): Unit

companion object Feature : ApplicationFeature<Application, Configuration, DefaultHeaders>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DefaultHeaders
val key: AttributeKey<DefaultHeaders>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DefaultHeaders
val key: AttributeKey<DefaultHeaders>

class DefaultResponsePushBuilder : ResponsePushBuilder

DefaultResponsePushBuilder(url: URLBuilder, headers: Headers)
DefaultResponsePushBuilder(call: ApplicationCall)
DefaultResponsePushBuilder(method: HttpMethod = HttpMethod.Get, url: URLBuilder = URLBuilder(), headers: HeadersBuilder = HeadersBuilder(), versions: List<Version> = emptyList())
val headers: HeadersBuilder
var method: HttpMethod
val url: URLBuilder
var versions: ArrayList<Version>

object DeflateEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel

class DelegatingConversionService : ConversionService

fun decode(converter: (values: List<String>, type: Type) -> Any?): Unit
fun encode(converter: (value: Any?) -> List<String>): Unit
fun fromValues(values: List<String>, type: Type): Any?
fun toValues(value: Any?): List<String>

class DispatcherWithShutdown : CoroutineDispatcher

DispatcherWithShutdown(delegate: CoroutineDispatcher)
fun completeShutdown(): Unit
fun dispatch(context: <ERROR CLASS>, block: Runnable): Unit
fun isDispatchNeeded(context: <ERROR CLASS>): Boolean
fun prepareShutdown(): Unit

class DoubleReceive

class Configuration

Configuration()
var receiveEntireContent: Boolean

companion object Feature : ApplicationFeature<Application, Configuration, DoubleReceive>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DoubleReceive
val key: AttributeKey<DoubleReceive>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DoubleReceive
val key: AttributeKey<DoubleReceive>

class DuplicateApplicationFeatureException : Exception

DuplicateApplicationFeatureException(message: String)

open class EventDefinition<T>

EventDefinition()

typealias EventHandler<T> = (T) -> Unit
object ForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>

data class ForwardedHeaderValue

ForwardedHeaderValue(host: String?, by: String?, forParam: String?, proto: String?, others: Map<String, String>)
val by: String?
val forParam: String?
val host: String?
val others: Map<String, String>
val proto: String?

val ForwardedParsedKey: AttributeKey<List<ForwardedHeaderValue>>
fun install(pipeline: ApplicationCallPipeline, configure: Unit.() -> Unit): Unit
val key: AttributeKey<Unit>

object GzipEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel

class HSTS

HSTS(config: Configuration)
class Configuration

Configuration()
val customDirectives: MutableMap<String, String?>
var includeSubDomains: Boolean
var maxAge: Duration
var maxAgeInSeconds: Long
var preload: Boolean

const val DEFAULT_HSTS_MAX_AGE: Long
companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HSTS>

const val DEFAULT_HSTS_MAX_AGE: Long
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HSTS
val key: AttributeKey<HSTS>

val headerValue: String
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HSTS
fun intercept(call: ApplicationCall): Unit
val key: AttributeKey<HSTS>

class HeaderIdSessionBuilder<S : Any> : HeaderSessionBuilder<S>

HeaderIdSessionBuilder(type: KClass<S>)
fun identity(f: () -> String): Unit
var sessionIdProvider: () -> String

open class HeaderSessionBuilder<S : Any>

HeaderSessionBuilder(type: KClass<S>)
var serializer: SessionSerializer<S>
fun transform(transformer: SessionTransportTransformer): Unit
val transformers: List<SessionTransportTransformer>
val type: KClass<S>
val typeInfo: KType

open class HoconApplicationConfig : ApplicationConfig

HoconApplicationConfig(config: Config)
open fun config(path: String): ApplicationConfig
open fun configList(path: String): List<ApplicationConfig>
open fun property(path: String): ApplicationConfigValue
open fun propertyOrNull(path: String): ApplicationConfigValue?

data class HostRouteSelector : RouteSelector

HostRouteSelector(hostList: List<String>, hostPatterns: List<Regex>, portsList: List<Int>)
const val HostNameParameter: String
const val PortParameter: String
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val hostList: List<String>
val hostPatterns: List<Regex>
val portsList: List<Int>
fun toString(): String

data class HttpAcceptRouteSelector : RouteSelector

HttpAcceptRouteSelector(contentType: ContentType)
val contentType: ContentType
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

data class HttpHeaderRouteSelector : RouteSelector

HttpHeaderRouteSelector(name: String, value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String
val value: String

data class HttpMethodRouteSelector : RouteSelector

HttpMethodRouteSelector(method: HttpMethod)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val method: HttpMethod
fun toString(): String

class HttpStatusCodeContent : NoContent

HttpStatusCodeContent(value: HttpStatusCode)
val status: HttpStatusCode

class HttpsRedirect

HttpsRedirect(config: Configuration)
class Configuration

Configuration()
fun exclude(predicate: (call: ApplicationCall) -> Boolean): Unit
val excludePredicates: MutableList<(ApplicationCall) -> Boolean>
fun excludePrefix(pathPrefix: String): Unit
fun excludeSuffix(pathSuffix: String): Unit
var permanentRedirect: Boolean
var sslPort: Int

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HttpsRedirect>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HttpsRedirect
val key: AttributeKey<HttpsRedirect>

val excludePredicates: List<(ApplicationCall) -> Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HttpsRedirect
val key: AttributeKey<HttpsRedirect>
val permanent: Boolean
val redirectPort: Int

object IdentityEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel
fun predictCompressedLength(originalLength: Long): Long

class IgnoreTrailingSlash

class Configuration

Configuration()

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, IgnoreTrailingSlash>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): IgnoreTrailingSlash
val key: AttributeKey<IgnoreTrailingSlash>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): IgnoreTrailingSlash
val key: AttributeKey<IgnoreTrailingSlash>

class JarFileContent : ReadChannelContent

JarFileContent(zipFilePath: Path, resourcePath: String, contentType: ContentType)
JarFileContent(jarFile: File, resourcePath: String, contentType: ContentType)
val contentLength: Long?
val contentType: ContentType
val isFile: Boolean
val jarFile: File
fun readFrom(): ByteReadChannel
val resourcePath: String

class LocalFileContent : ReadChannelContent

LocalFileContent(file: File, contentType: ContentType = ContentType.defaultForFile(file))
val contentLength: Long
val contentType: ContentType
val file: File
fun readFrom(): ByteReadChannel
fun readFrom(range: LongRange): ByteReadChannel

data class LocalPortRouteSelector : RouteSelector

LocalPortRouteSelector(port: Int)
const val LocalPortParameter: String
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val port: Int

open class MapApplicationConfig : ApplicationConfig

MapApplicationConfig(vararg values: Pair<String, String>)
MapApplicationConfig()
protected class MapApplicationConfigValue : ApplicationConfigValue

MapApplicationConfigValue(map: Map<String, String>, path: String)
fun getList(): List<String>
fun getString(): String
val map: Map<String, String>
val path: String

open fun config(path: String): ApplicationConfig
open fun configList(path: String): List<ApplicationConfig>
protected val map: MutableMap<String, String>
protected val path: String
open fun property(path: String): ApplicationConfigValue
open fun propertyOrNull(path: String): ApplicationConfigValue?
fun put(path: String, value: String): Unit
fun put(path: String, values: Iterable<String>): Unit

class MissingApplicationFeatureException : IllegalStateException, CopyableThrowable<MissingApplicationFeatureException>

MissingApplicationFeatureException(key: AttributeKey<*>)
fun createCopy(): MissingApplicationFeatureException?
val key: AttributeKey<*>
val message: String

class MissingRequestParameterException : BadRequestException, CopyableThrowable<MissingRequestParameterException>

MissingRequestParameterException(parameterName: String)
fun createCopy(): MissingRequestParameterException
val parameterName: String

class MutableOriginConnectionPoint : RequestConnectionPoint

MutableOriginConnectionPoint(delegate: RequestConnectionPoint)
var host: String
var method: HttpMethod
var port: Int
var remoteHost: String
var scheme: String
var uri: String
var version: String

class NotFoundException : Exception

NotFoundException(message: String? = "Resource not found")

data class OptionalParameterRouteSelector : RouteSelector

OptionalParameterRouteSelector(name: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String

data class OrRouteSelector : RouteSelector

OrRouteSelector(first: RouteSelector, second: RouteSelector)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val first: RouteSelector
val second: RouteSelector
fun toString(): String

class ParameterConversionException : BadRequestException, CopyableThrowable<ParameterConversionException>

ParameterConversionException(parameterName: String, type: String, cause: Throwable? = null)
fun createCopy(): ParameterConversionException
val parameterName: String
val type: String

data class ParameterRouteSelector : RouteSelector

ParameterRouteSelector(name: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String

class PartialContent

PartialContent(maxRangeCount: Int)
class Configuration

Configuration()
var maxRangeCount: Int

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, PartialContent>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): PartialContent
val key: AttributeKey<PartialContent>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): PartialContent
val key: AttributeKey<PartialContent>

data class PathSegmentConstantRouteSelector : RouteSelector

PathSegmentConstantRouteSelector(value: String, hasTrailingSlash: Boolean)
PathSegmentConstantRouteSelector(value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String
val value: String

data class PathSegmentOptionalParameterRouteSelector : RouteSelector

PathSegmentOptionalParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null, hasTrailingSlash: Boolean)
PathSegmentOptionalParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String?
val suffix: String?
fun toString(): String

data class PathSegmentParameterRouteSelector : RouteSelector

PathSegmentParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null, hasTrailingSlash: Boolean)
PathSegmentParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String?
val suffix: String?
fun toString(): String

object PathSegmentSelectorBuilder

fun parseConstant(value: String): RouteSelector
fun parseConstant(value: String, hasTrailingSlash: Boolean): RouteSelector
fun parseName(value: String): String
fun parseParameter(value: String): RouteSelector
fun parseParameter(value: String, hasTrailingSlash: Boolean): RouteSelector

data class PathSegmentTailcardRouteSelector : RouteSelector

PathSegmentTailcardRouteSelector(name: String = "", prefix: String = "", hasTrailingSlash: Boolean)
PathSegmentTailcardRouteSelector(name: String = "", prefix: String = "")
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String
fun toString(): String

object PathSegmentWildcardRouteSelector : RouteSelector

fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

class RejectedCallIdException : IllegalArgumentException, CopyableThrowable<RejectedCallIdException>

RejectedCallIdException(illegalCallId: String)
fun createCopy(): RejectedCallIdException?
val illegalCallId: String

class RequestAlreadyConsumedException : IllegalStateException

RequestAlreadyConsumedException()

open class RequestCookies

RequestCookies(request: ApplicationRequest)
protected open fun fetchCookies(): Map<String, String>
operator fun get(name: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING): String?
val rawCookies: Map<String, String>
protected val request: ApplicationRequest

class RequestReceiveAlreadyFailedException : Exception
class ResponseCookies

ResponseCookies(response: ApplicationResponse, secureTransport: Boolean)
fun append(item: Cookie): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Long = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun appendExpired(name: String, domain: String? = null, path: String? = null): Unit
operator fun get(name: String): Cookie?

abstract class ResponseHeaders

ResponseHeaders()
fun allValues(): Headers
fun append(name: String, value: String, safeOnly: Boolean = true): Unit
operator fun contains(name: String): Boolean
protected abstract fun engineAppendHeader(name: String, value: String): Unit
open operator fun get(name: String): String?
protected abstract fun getEngineHeaderNames(): List<String>
protected abstract fun getEngineHeaderValues(name: String): List<String>
fun values(name: String): List<String>

interface ResponsePushBuilder

abstract val headers: HeadersBuilder
abstract var method: HttpMethod
abstract val url: URLBuilder
abstract val versions: MutableList<Version>

class RootRouteSelector : RouteSelector

RootRouteSelector(rootPath: String = "")
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

open class Route : ApplicationCallPipeline

Route(parent: Route?, selector: RouteSelector)
Route(parent: Route?, selector: RouteSelector, developmentMode: Boolean)
open fun afterIntercepted(): Unit
val children: List<Route>
fun createChild(selector: RouteSelector): Route
fun handle(handler: <ERROR CLASS><Unit, ApplicationCall>): Unit
operator fun invoke(body: Route.() -> Unit): Unit
val parent: Route?
val selector: RouteSelector
open fun toString(): String

abstract class RouteSelector

RouteSelector(quality: Double)
abstract fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val quality: Double

data class RouteSelectorEvaluation

RouteSelectorEvaluation(succeeded: Boolean, quality: Double, parameters: Parameters = Parameters.Empty, segmentIncrement: Int = 0)
val Constant: RouteSelectorEvaluation
val ConstantPath: RouteSelectorEvaluation
val Failed: RouteSelectorEvaluation
val Missing: RouteSelectorEvaluation
val WildcardPath: RouteSelectorEvaluation
val parameters: Parameters
val quality: Double
const val qualityConstant: Double
const val qualityMethodParameter: Double
const val qualityMissing: Double
const val qualityParameter: Double
const val qualityParameterWithPrefixOrSuffix: Double
const val qualityPathParameter: Double
const val qualityQueryParameter: Double
const val qualityTailcard: Double
const val qualityTransparent: Double
const val qualityWildcard: Double
val segmentIncrement: Int
val succeeded: Boolean

class Routing : Route

Routing(application: Application)
companion object Feature : ApplicationFeature<Application, Routing, Routing>

val RoutingCallFinished: EventDefinition<RoutingApplicationCall>
val RoutingCallStarted: EventDefinition<RoutingApplicationCall>
fun install(pipeline: Application, configure: Routing.() -> Unit): Routing
val key: AttributeKey<Routing>

val RoutingCallFinished: EventDefinition<RoutingApplicationCall>
val RoutingCallStarted: EventDefinition<RoutingApplicationCall>
val application: Application
fun install(pipeline: Application, configure: Routing.() -> Unit): Routing
suspend fun interceptor(context: PipelineContext<Unit, ApplicationCall>): Unit
val key: AttributeKey<Routing>
fun trace(block: (RoutingResolveTrace) -> Unit): Unit

class RoutingApplicationCall : ApplicationCall

RoutingApplicationCall(call: ApplicationCall, route: Route, receivePipeline: ApplicationReceivePipeline, responsePipeline: ApplicationSendPipeline, parameters: Parameters)
val application: Application
val attributes: Attributes
val parameters: Parameters
val request: RoutingApplicationRequest
val response: RoutingApplicationResponse
val route: Route
fun toString(): String

class RoutingApplicationRequest : ApplicationRequest

RoutingApplicationRequest(call: RoutingApplicationCall, pipeline: ApplicationReceivePipeline, request: ApplicationRequest)
val call: RoutingApplicationCall
val pipeline: ApplicationReceivePipeline

class RoutingApplicationResponse : ApplicationResponse

RoutingApplicationResponse(call: RoutingApplicationCall, pipeline: ApplicationSendPipeline, response: ApplicationResponse)
val call: RoutingApplicationCall
val pipeline: ApplicationSendPipeline

class RoutingPath

fun parse(path: String): RoutingPath
val parts: List<RoutingPathSegment>
val root: RoutingPath
fun toString(): String

data class RoutingPathSegment

RoutingPathSegment(value: String, kind: RoutingPathSegmentKind)
val kind: RoutingPathSegmentKind
val value: String

enum class RoutingPathSegmentKind

Constant
Parameter

class RoutingResolveContext

RoutingResolveContext(routing: Route, call: ApplicationCall, tracers: List<(RoutingResolveTrace) -> Unit>)
val call: ApplicationCall
val hasTrailingSlash: Boolean
fun resolve(): RoutingResolveResult
val routing: Route
val segments: List<String>

sealed class RoutingResolveResult

class Failure : RoutingResolveResult

Failure(route: Route, reason: String)
val parameters: Nothing
val reason: String
fun toString(): String

class Success : RoutingResolveResult

Success(route: Route, parameters: Parameters)
val parameters: Parameters
fun toString(): String

abstract val parameters: Parameters
val route: Route

class RoutingResolveTrace

RoutingResolveTrace(call: ApplicationCall, segments: List<String>)
fun begin(route: Route, segmentIndex: Int): Unit
fun buildText(): String
val call: ApplicationCall
fun finish(route: Route, segmentIndex: Int, result: RoutingResolveResult): Unit
val segments: List<String>
fun skip(route: Route, segmentIndex: Int, result: RoutingResolveResult): Unit
fun toString(): String

open class RoutingResolveTraceEntry

RoutingResolveTraceEntry(route: Route, segmentIndex: Int, result: RoutingResolveResult? = null)
fun append(item: RoutingResolveTraceEntry): Unit
open fun buildText(builder: StringBuilder, indent: Int): Unit
var result: RoutingResolveResult?
val route: Route
val segmentIndex: Int
open fun toString(): String

class SessionNotYetConfiguredException : IllegalStateException

SessionNotYetConfiguredException()

class SessionProvider<S : Any>

SessionProvider(name: String, type: KClass<S>, transport: SessionTransport, tracker: SessionTracker<S>)
val name: String
fun toString(): String
val tracker: SessionTracker<S>
val transport: SessionTransport
val type: KClass<S>

interface SessionSerializer<T>

abstract fun deserialize(text: String): T
abstract fun serialize(session: T): String

class SessionSerializerReflection<T : Any> : SessionSerializer<T>

SessionSerializerReflection(type: KClass<T>)
fun deserialize(text: String): T
fun serialize(session: T): String
val type: KClass<T>

interface SessionStorage

abstract suspend fun invalidate(id: String): Unit
abstract suspend fun <R> read(id: String, consumer: suspend (ByteReadChannel) -> R): R
abstract suspend fun write(id: String, provider: suspend (ByteWriteChannel) -> Unit): Unit

class SessionStorageMemory : SessionStorage

SessionStorageMemory()
suspend fun invalidate(id: String): Unit
suspend fun <R> read(id: String, consumer: suspend (ByteReadChannel) -> R): R
suspend fun write(id: String, provider: suspend (ByteWriteChannel) -> Unit): Unit

interface SessionTracker<S : Any>

abstract suspend fun clear(call: ApplicationCall): Unit
abstract suspend fun load(call: ApplicationCall, transport: String?): S?
abstract suspend fun store(call: ApplicationCall, value: S): String
abstract fun validate(value: S): Unit

class SessionTrackerById<S : Any> : SessionTracker<S>

SessionTrackerById(type: KClass<S>, serializer: SessionSerializer<S>, storage: SessionStorage, sessionIdProvider: () -> String)
suspend fun clear(call: ApplicationCall): Unit
suspend fun load(call: ApplicationCall, transport: String?): S?
val serializer: SessionSerializer<S>
val sessionIdProvider: () -> String
val storage: SessionStorage
suspend fun store(call: ApplicationCall, value: S): String
fun toString(): String
val type: KClass<S>
fun validate(value: S): Unit

class SessionTrackerByValue<S : Any> : SessionTracker<S>

SessionTrackerByValue(type: KClass<S>, serializer: SessionSerializer<S>)
suspend fun clear(call: ApplicationCall): Unit
suspend fun load(call: ApplicationCall, transport: String?): S?
val serializer: SessionSerializer<S>
suspend fun store(call: ApplicationCall, value: S): String
fun toString(): String
val type: KClass<S>
fun validate(value: S): Unit

interface SessionTransport

abstract fun clear(call: ApplicationCall): Unit
abstract fun receive(call: ApplicationCall): String?
abstract fun send(call: ApplicationCall, value: String): Unit

class SessionTransportCookie : SessionTransport

SessionTransportCookie(name: String, configuration: CookieConfiguration, transformers: List<SessionTransportTransformer>)
fun clear(call: ApplicationCall): Unit
val configuration: CookieConfiguration
val name: String
fun receive(call: ApplicationCall): String?
fun send(call: ApplicationCall, value: String): Unit
fun toString(): String
val transformers: List<SessionTransportTransformer>

class SessionTransportHeader : SessionTransport

SessionTransportHeader(name: String, transformers: List<SessionTransportTransformer>)
fun clear(call: ApplicationCall): Unit
val name: String
fun receive(call: ApplicationCall): String?
fun send(call: ApplicationCall, value: String): Unit
fun toString(): String
val transformers: List<SessionTransportTransformer>

interface SessionTransportTransformer

abstract fun transformRead(transportValue: String): String?
abstract fun transformWrite(transportValue: String): String

class SessionTransportTransformerDigest : SessionTransportTransformer

SessionTransportTransformerDigest(salt: String = "ktor", algorithm: String = "SHA-384")
val algorithm: String
val salt: String
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class SessionTransportTransformerEncrypt : SessionTransportTransformer

SessionTransportTransformerEncrypt(encryptionKey: ByteArray, signKey: ByteArray, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = "AES", signAlgorithm: String = "HmacSHA256")
SessionTransportTransformerEncrypt(encryptionKeySpec: SecretKeySpec, signKeySpec: SecretKeySpec, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = encryptionKeySpec.algorithm, signAlgorithm: String = signKeySpec.algorithm)
val encryptAlgorithm: String
val encryptionKeySize: Int
val encryptionKeySpec: SecretKeySpec
val ivGenerator: (size: Int) -> ByteArray
val signAlgorithm: String
val signKeySpec: SecretKeySpec
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class SessionTransportTransformerMessageAuthentication : SessionTransportTransformer

SessionTransportTransformerMessageAuthentication(key: ByteArray, algorithm: String = "HmacSHA256")
SessionTransportTransformerMessageAuthentication(keySpec: SecretKeySpec, algorithm: String = "HmacSHA256")
val algorithm: String
val keySpec: SecretKeySpec
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class Sessions

Sessions(providers: List<SessionProvider<*>>)
class Configuration

Configuration()
val providers: List<SessionProvider<*>>
fun register(provider: SessionProvider<*>): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Sessions>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Sessions
val key: AttributeKey<Sessions>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Sessions
val key: AttributeKey<Sessions>
val providers: List<SessionProvider<*>>

class StatusPages

StatusPages(config: Configuration)
class Configuration

Configuration()
inline fun <reified T : Throwable> exception(noinline handler: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
fun <T : Throwable> exception(klass: Class<T>, handler: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
val exceptions: MutableMap<Class<*>, suspend PipelineContext<*, ApplicationCall>.(Throwable) -> Unit>
fun status(vararg status: HttpStatusCode, handler: suspend PipelineContext<*, ApplicationCall>.(HttpStatusCode) -> Unit): Unit
val statuses: MutableMap<HttpStatusCode, suspend PipelineContext<*, ApplicationCall>.(HttpStatusCode) -> Unit>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, StatusPages>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): StatusPages
val key: AttributeKey<StatusPages>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): StatusPages
val key: AttributeKey<StatusPages>

class TooLateSessionSetException : IllegalStateException

TooLateSessionSetException()

class UnsupportedMediaTypeException : ContentTransformationException, CopyableThrowable<UnsupportedMediaTypeException>

UnsupportedMediaTypeException(contentType: ContentType)
fun createCopy(): UnsupportedMediaTypeException?

annotation class UseHttp2Push

UseHttp2Push()

object XForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Config, Config>

class Config

Config()
val forHeaders: <ERROR CLASS><String>
val hostHeaders: <ERROR CLASS><String>
val httpsFlagHeaders: <ERROR CLASS><String>
val protoHeaders: <ERROR CLASS><String>

fun install(pipeline: ApplicationCallPipeline, configure: Config.() -> Unit): Config
val key: AttributeKey<Config>

com.typesafe.config.Config

fun Config.tryGetString(path: String): String?
fun Config.tryGetStringList(path: String): List<String>?

io.ktor.util.pipeline.PipelineContext

val PipelineContext<*, ApplicationCall>.application: Application
inline val PipelineContext<*, ApplicationCall>.call: ApplicationCall

io.ktor.util.pipeline.PipelineContext

fun PipelineContext<Any, ApplicationCall>.transformDefaultContent(value: Any): OutgoingContent?

java.time.Instant

fun Instant.toGMTDate(): GMTDate

java.time.ZonedDateTime

fun ZonedDateTime.toGMTDate(): GMTDate

java.time.temporal.Temporal

fun Temporal.toHttpDateString(): String
@JvmName("toHttpDateString") fun Temporal.toHttpDateString0(): String

java.util.Date

fun Date.toLocalDateTime(): LocalDateTime
fun Date.toZonedDateTime(): ZonedDateTime

kotlin.Long

fun Long.toHttpDateString(): String

kotlin.String

fun String.fromHttpDateString(): ZonedDateTime
@JvmName("fromHttpDateString") fun String.fromHttpDateString0(): ZonedDateTime

kotlin.collections.List

fun List<ContentTypeWithQuality>.sortedByQuality(): List<ContentTypeWithQuality>

kotlin.collections.List

fun List<SessionTransportTransformer>.transformRead(cookieValue: String?): String?
fun List<SessionTransportTransformer>.transformWrite(value: String): String

kotlin.collections.List

fun List<String>.normalizePathComponents(): List<String>

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.writeMultipleRanges(channelProducer: (LongRange) -> ByteReadChannel, ranges: List<LongRange>, fullLength: Long?, boundary: String, contentType: String): ByteReadChannel

package io.ktor.application

class Application : ApplicationCallPipeline, CoroutineScope

Application(environment: ApplicationEnvironment)
val coroutineContext: <ERROR CLASS>
fun dispose(): Unit
val environment: ApplicationEnvironment

interface ApplicationCall

abstract val application: Application
abstract val attributes: Attributes
abstract val parameters: Parameters
abstract val request: ApplicationRequest
abstract val response: ApplicationResponse

open class ApplicationCallPipeline : Pipeline<Unit, ApplicationCall>

ApplicationCallPipeline(developmentMode: Boolean = false)
val Call: PipelinePhase
val Fallback: PipelinePhase
val Features: PipelinePhase
val Monitoring: PipelinePhase
val Setup: PipelinePhase
val developmentMode: Boolean
val receivePipeline: ApplicationReceivePipeline
val sendPipeline: ApplicationSendPipeline

interface ApplicationEnvironment

abstract val classLoader: ClassLoader
abstract val config: ApplicationConfig
abstract val developmentMode: Boolean
abstract val log: Logger
abstract val monitor: ApplicationEvents
abstract val parentCoroutineContext: <ERROR CLASS>
abstract val rootPath: String

class ApplicationEvents

ApplicationEvents()
fun <T> raise(definition: EventDefinition<T>, value: T): Unit
fun <T> subscribe(definition: EventDefinition<T>, handler: EventHandler<T>): DisposableHandle
fun <T> unsubscribe(definition: EventDefinition<T>, handler: EventHandler<T>): Unit

interface ApplicationFeature<in TPipeline : Pipeline<*, ApplicationCall>, out TConfiguration : Any, TFeature : Any>

abstract fun install(pipeline: TPipeline, configure: TConfiguration.() -> Unit): TFeature
abstract val key: AttributeKey<TFeature>

val ApplicationStarted: EventDefinition<Application>
val ApplicationStarting: EventDefinition<Application>
val ApplicationStopPreparing: EventDefinition<ApplicationEnvironment>
val ApplicationStopped: EventDefinition<Application>
val ApplicationStopping: EventDefinition<Application>
class DuplicateApplicationFeatureException : Exception

DuplicateApplicationFeatureException(message: String)

open class EventDefinition<T>

EventDefinition()

typealias EventHandler<T> = (T) -> Unit
class MissingApplicationFeatureException : IllegalStateException, CopyableThrowable<MissingApplicationFeatureException>

MissingApplicationFeatureException(key: AttributeKey<*>)
fun createCopy(): MissingApplicationFeatureException?
val key: AttributeKey<*>
val message: String

fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.feature(feature: ApplicationFeature<A, B, F>): F
fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.featureOrNull(feature: ApplicationFeature<A, B, F>): F?
fun <P : Pipeline<*, ApplicationCall>, B : Any, F : Any> P.install(feature: ApplicationFeature<P, B, F>, configure: B.() -> Unit = {}): F
io.ktor.util.pipeline.PipelineContext

val PipelineContext<*, ApplicationCall>.application: Application
inline val PipelineContext<*, ApplicationCall>.call: ApplicationCall

val Application.log: Logger
fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.uninstall(feature: ApplicationFeature<A, B, F>): Unit
fun <A : Pipeline<*, ApplicationCall>> A.uninstallAllFeatures(): Unit
fun <A : Pipeline<*, ApplicationCall>, F : Any> A.uninstallFeature(key: AttributeKey<F>): Unit

package io.ktor.config

interface ApplicationConfig

abstract fun config(path: String): ApplicationConfig
abstract fun configList(path: String): List<ApplicationConfig>
abstract fun property(path: String): ApplicationConfigValue
abstract fun propertyOrNull(path: String): ApplicationConfigValue?

interface ApplicationConfigValue

abstract fun getList(): List<String>
abstract fun getString(): String

class ApplicationConfigurationException : Exception

ApplicationConfigurationException(message: String)

open class HoconApplicationConfig : ApplicationConfig

HoconApplicationConfig(config: Config)
open fun config(path: String): ApplicationConfig
open fun configList(path: String): List<ApplicationConfig>
open fun property(path: String): ApplicationConfigValue
open fun propertyOrNull(path: String): ApplicationConfigValue?

open class MapApplicationConfig : ApplicationConfig

MapApplicationConfig(vararg values: Pair<String, String>)
MapApplicationConfig()
protected class MapApplicationConfigValue : ApplicationConfigValue

MapApplicationConfigValue(map: Map<String, String>, path: String)
fun getList(): List<String>
fun getString(): String
val map: Map<String, String>
val path: String

open fun config(path: String): ApplicationConfig
open fun configList(path: String): List<ApplicationConfig>
protected val map: MutableMap<String, String>
protected val path: String
open fun property(path: String): ApplicationConfigValue
open fun propertyOrNull(path: String): ApplicationConfigValue?
fun put(path: String, value: String): Unit
fun put(path: String, values: Iterable<String>): Unit

com.typesafe.config.Config

fun Config.tryGetString(path: String): String?
fun Config.tryGetStringList(path: String): List<String>?

package io.ktor.features

typealias AcceptHeaderContributor = (call: ApplicationCall, acceptedContentTypes: List<ContentTypeWithQuality>) -> List<ContentTypeWithQuality>
object AutoHeadResponse : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>

fun install(pipeline: ApplicationCallPipeline, configure: Unit.() -> Unit): Unit
val key: AttributeKey<Unit>

open class BadRequestException : Exception

BadRequestException(message: String, cause: Throwable? = null)

const val CALL_ID_DEFAULT_DICTIONARY: String
class CORS

CORS(configuration: Configuration)
const val CORS_DEFAULT_MAX_AGE: Long
class Configuration

Configuration()
val CorsDefaultHeaders: Set<String>
val CorsDefaultMethods: Set<HttpMethod>
val CorsSimpleContentTypes: Set<ContentType>
val CorsSimpleRequestHeaders: Set<String>
val CorsSimpleResponseHeaders: Set<String>
var allowCredentials: Boolean
fun allowHeaders(predicate: (String) -> Boolean): Unit
fun allowHeadersPrefixed(headerPrefix: String): Unit
var allowNonSimpleContentTypes: Boolean
var allowSameOrigin: Boolean
fun allowXHttpMethodOverride(): Unit
fun anyHost(): Unit
fun exposeHeader(header: String): Unit
fun exposeXHttpMethodOverride(): Unit
val exposedHeaders: MutableSet<String>
fun header(header: String): Unit
val headerPredicates: MutableList<(String) -> Boolean>
val headers: MutableSet<String>
fun host(host: String, schemes: List<String> = listOf("http"), subDomains: List<String> = emptyList()): Unit
val hosts: MutableSet<String>
var maxAge: Duration
var maxAgeInSeconds: Long
fun method(method: HttpMethod): Unit
val methods: MutableSet<HttpMethod>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CORS>

const val CORS_DEFAULT_MAX_AGE: Long
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CORS
val key: AttributeKey<CORS>

val allHeaders: Set<String>
val allHeadersSet: Set<String>
val allowCredentials: Boolean
val allowSameOrigin: Boolean
val allowsAnyHost: Boolean
val headerPredicates: List<(String) -> Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CORS
suspend fun intercept(context: PipelineContext<Unit, ApplicationCall>): Unit
val key: AttributeKey<CORS>
val methods: Set<HttpMethod>

sealed class CachedTransformationResult<T : Any>

open class Failure : CachedTransformationResult<Nothing>

Failure(type: KType, cause: Throwable)
val cause: Throwable

class Success<T : Any> : CachedTransformationResult<T>

Success(type: KType, value: T)
val value: T

val type: KType

class CachingHeaders

CachingHeaders(optionsProviders: List<(OutgoingContent) -> CachingOptions?>)
class Configuration

Configuration()
fun options(provider: (OutgoingContent) -> CachingOptions?): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CachingHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CachingHeaders
val key: AttributeKey<CachingHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CachingHeaders
val key: AttributeKey<CachingHeaders>
fun optionsFor(content: OutgoingContent): List<CachingOptions>

class CallId

class Configuration

Configuration()
fun generate(block: CallIdProvider): Unit
fun header(headerName: String): Unit
fun reply(block: (call: ApplicationCall, callId: String) -> Unit): Unit
fun replyToHeader(headerName: String): Unit
fun retrieve(block: CallIdProvider): Unit
fun retrieveFromHeader(headerName: String): Unit
fun verify(predicate: CallIdVerifier): Unit
fun verify(dictionary: String, reject: Boolean = false): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, CallId>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CallId
val key: AttributeKey<CallId>
val phase: PipelinePhase

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): CallId
val key: AttributeKey<CallId>
val phase: PipelinePhase

typealias CallIdProvider = (call: ApplicationCall) -> String?
typealias CallIdVerifier = (String) -> Boolean
class CallLogging

class Configuration

Configuration()
fun filter(predicate: (ApplicationCall) -> Boolean): Unit
fun format(formatter: (ApplicationCall) -> String): Unit
var level: Level
var logger: Logger?
fun mdc(name: String, provider: (ApplicationCall) -> String?): Unit

companion object Feature : ApplicationFeature<Application, Configuration, CallLogging>

fun install(pipeline: Application, configure: Configuration.() -> Unit): CallLogging
val key: AttributeKey<CallLogging>

object Internals

suspend fun <C : PipelineContext<*, ApplicationCall>> C.withMDCBlock(block: suspend C.() -> Unit): Unit
suspend fun withMDCBlock(call: ApplicationCall, block: suspend () -> Unit): Unit

fun install(pipeline: Application, configure: Configuration.() -> Unit): CallLogging
val key: AttributeKey<CallLogging>

class Compression

Compression(compression: Configuration)
class Configuration : ConditionsHolderBuilder

Configuration()
fun build(): CompressionOptions
val conditions: MutableList<ApplicationCall.(OutgoingContent) -> Boolean>
fun default(): Unit
fun encoder(name: String, encoder: CompressionEncoder, block: CompressionEncoderBuilder.() -> Unit = {}): Unit
val encoders: MutableMap<String, CompressionEncoderBuilder>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Compression>

val SuppressionAttribute: AttributeKey<Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Compression
val key: AttributeKey<Compression>

val SuppressionAttribute: AttributeKey<Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Compression
val key: AttributeKey<Compression>

interface CompressionEncoder

abstract fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS> = Dispatchers.Unconfined): ByteReadChannel
abstract fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS> = Dispatchers.Unconfined): ByteWriteChannel
open fun predictCompressedLength(originalLength: Long): Long?

class CompressionEncoderBuilder : ConditionsHolderBuilder

fun build(): CompressionEncoderConfig
val conditions: ArrayList<ApplicationCall.(OutgoingContent) -> Boolean>
val encoder: CompressionEncoder
val name: String
var priority: Double

data class CompressionEncoderConfig

CompressionEncoderConfig(name: String, encoder: CompressionEncoder, conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>, priority: Double)
val conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>
val encoder: CompressionEncoder
val name: String
val priority: Double

data class CompressionOptions

CompressionOptions(encoders: Map<String, CompressionEncoderConfig> = emptyMap(), conditions: List<ApplicationCall.(OutgoingContent) -> Boolean> = emptyList())
val conditions: List<ApplicationCall.(OutgoingContent) -> Boolean>
val encoders: Map<String, CompressionEncoderConfig>

class ConditionalHeaders

ConditionalHeaders(versionProviders: List<suspend (OutgoingContent) -> List<Version>>)
class Configuration

Configuration()
fun version(provider: suspend (OutgoingContent) -> List<Version>): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ConditionalHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ConditionalHeaders
val key: AttributeKey<ConditionalHeaders>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ConditionalHeaders
val key: AttributeKey<ConditionalHeaders>
suspend fun versionsFor(content: OutgoingContent): List<Version>

interface ConditionsHolderBuilder

abstract val conditions: MutableList<ApplicationCall.(OutgoingContent) -> Boolean>

interface ContentConverter

abstract suspend fun convertForReceive(context: PipelineContext<ApplicationReceiveRequest, ApplicationCall>): Any?
abstract suspend fun convertForSend(context: PipelineContext<Any, ApplicationCall>, contentType: ContentType, value: Any): Any?

class ContentNegotiation

ContentNegotiation(registrations: List<ConverterRegistration>, acceptContributors: List<AcceptHeaderContributor>)
class Configuration

Configuration()
fun accept(contributor: AcceptHeaderContributor): Unit
var checkAcceptHeaderCompliance: Boolean
fun <T : ContentConverter> register(contentType: ContentType, converter: T, configuration: T.() -> Unit = {}): Unit

data class ConverterRegistration

ConverterRegistration(contentType: ContentType, converter: ContentConverter)
val contentType: ContentType
val converter: ContentConverter

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, ContentNegotiation>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ContentNegotiation
val key: AttributeKey<ContentNegotiation>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): ContentNegotiation
val key: AttributeKey<ContentNegotiation>
val registrations: List<ConverterRegistration>

abstract class ContentTransformationException : Exception

ContentTransformationException(message: String)

data class ContentTypeWithQuality

ContentTypeWithQuality(contentType: ContentType, quality: Double = 1.0)
val contentType: ContentType
val quality: Double

class DataConversion : ConversionService

DataConversion(converters: Map<Type, ConversionService>)
class Configuration

Configuration()
fun convert(klass: KClass<*>, convertor: ConversionService): Unit
fun convert(ktype: KType, convertor: ConversionService): Unit
fun convert(klass: KClass<*>, configure: DelegatingConversionService.() -> Unit): Unit
inline fun <reified T> convert(noinline configure: DelegatingConversionService.() -> Unit): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, DataConversion>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): DataConversion
val key: AttributeKey<DataConversion>

fun fromValues(values: List<String>, type: Type): Any?
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): DataConversion
val key: AttributeKey<DataConversion>
fun toValues(value: Any?): List<String>

class DefaultHeaders

DefaultHeaders(config: Configuration)
class Configuration

Configuration()
var clock: () -> Long
fun header(name: String, value: String): Unit

companion object Feature : ApplicationFeature<Application, Configuration, DefaultHeaders>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DefaultHeaders
val key: AttributeKey<DefaultHeaders>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DefaultHeaders
val key: AttributeKey<DefaultHeaders>

object DeflateEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel

class DelegatingConversionService : ConversionService

fun decode(converter: (values: List<String>, type: Type) -> Any?): Unit
fun encode(converter: (value: Any?) -> List<String>): Unit
fun fromValues(values: List<String>, type: Type): Any?
fun toValues(value: Any?): List<String>

class DoubleReceive

class Configuration

Configuration()
var receiveEntireContent: Boolean

companion object Feature : ApplicationFeature<Application, Configuration, DoubleReceive>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DoubleReceive
val key: AttributeKey<DoubleReceive>

fun install(pipeline: Application, configure: Configuration.() -> Unit): DoubleReceive
val key: AttributeKey<DoubleReceive>

object ForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>

data class ForwardedHeaderValue

ForwardedHeaderValue(host: String?, by: String?, forParam: String?, proto: String?, others: Map<String, String>)
val by: String?
val forParam: String?
val host: String?
val others: Map<String, String>
val proto: String?

val ForwardedParsedKey: AttributeKey<List<ForwardedHeaderValue>>
fun install(pipeline: ApplicationCallPipeline, configure: Unit.() -> Unit): Unit
val key: AttributeKey<Unit>

object GzipEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel

class HSTS

HSTS(config: Configuration)
class Configuration

Configuration()
val customDirectives: MutableMap<String, String?>
var includeSubDomains: Boolean
var maxAge: Duration
var maxAgeInSeconds: Long
var preload: Boolean

const val DEFAULT_HSTS_MAX_AGE: Long
companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HSTS>

const val DEFAULT_HSTS_MAX_AGE: Long
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HSTS
val key: AttributeKey<HSTS>

val headerValue: String
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HSTS
fun intercept(call: ApplicationCall): Unit
val key: AttributeKey<HSTS>

class HttpsRedirect

HttpsRedirect(config: Configuration)
class Configuration

Configuration()
fun exclude(predicate: (call: ApplicationCall) -> Boolean): Unit
val excludePredicates: MutableList<(ApplicationCall) -> Boolean>
fun excludePrefix(pathPrefix: String): Unit
fun excludeSuffix(pathSuffix: String): Unit
var permanentRedirect: Boolean
var sslPort: Int

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, HttpsRedirect>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HttpsRedirect
val key: AttributeKey<HttpsRedirect>

val excludePredicates: List<(ApplicationCall) -> Boolean>
fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): HttpsRedirect
val key: AttributeKey<HttpsRedirect>
val permanent: Boolean
val redirectPort: Int

object IdentityEncoder : CompressionEncoder

fun compress(readChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>): ByteReadChannel
fun compress(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>): ByteWriteChannel
fun predictCompressedLength(originalLength: Long): Long

class MissingRequestParameterException : BadRequestException, CopyableThrowable<MissingRequestParameterException>

MissingRequestParameterException(parameterName: String)
fun createCopy(): MissingRequestParameterException
val parameterName: String

class MutableOriginConnectionPoint : RequestConnectionPoint

MutableOriginConnectionPoint(delegate: RequestConnectionPoint)
var host: String
var method: HttpMethod
var port: Int
var remoteHost: String
var scheme: String
var uri: String
var version: String

val MutableOriginConnectionPointKey: AttributeKey<MutableOriginConnectionPoint>
class NotFoundException : Exception

NotFoundException(message: String? = "Resource not found")

class ParameterConversionException : BadRequestException, CopyableThrowable<ParameterConversionException>

ParameterConversionException(parameterName: String, type: String, cause: Throwable? = null)
fun createCopy(): ParameterConversionException
val parameterName: String
val type: String

class PartialContent

PartialContent(maxRangeCount: Int)
class Configuration

Configuration()
var maxRangeCount: Int

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, PartialContent>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): PartialContent
val key: AttributeKey<PartialContent>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): PartialContent
val key: AttributeKey<PartialContent>

class RejectedCallIdException : IllegalArgumentException, CopyableThrowable<RejectedCallIdException>

RejectedCallIdException(illegalCallId: String)
fun createCopy(): RejectedCallIdException?
val illegalCallId: String

class RequestReceiveAlreadyFailedException : Exception
class StatusPages

StatusPages(config: Configuration)
class Configuration

Configuration()
inline fun <reified T : Throwable> exception(noinline handler: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
fun <T : Throwable> exception(klass: Class<T>, handler: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
val exceptions: MutableMap<Class<*>, suspend PipelineContext<*, ApplicationCall>.(Throwable) -> Unit>
fun status(vararg status: HttpStatusCode, handler: suspend PipelineContext<*, ApplicationCall>.(HttpStatusCode) -> Unit): Unit
val statuses: MutableMap<HttpStatusCode, suspend PipelineContext<*, ApplicationCall>.(HttpStatusCode) -> Unit>

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, StatusPages>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): StatusPages
val key: AttributeKey<StatusPages>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): StatusPages
val key: AttributeKey<StatusPages>

class UnsupportedMediaTypeException : ContentTransformationException, CopyableThrowable<UnsupportedMediaTypeException>

UnsupportedMediaTypeException(contentType: ContentType)
fun createCopy(): UnsupportedMediaTypeException?

object XForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Config, Config>

class Config

Config()
val forHeaders: <ERROR CLASS><String>
val hostHeaders: <ERROR CLASS><String>
val httpsFlagHeaders: <ERROR CLASS><String>
val protoHeaders: <ERROR CLASS><String>

fun install(pipeline: ApplicationCallPipeline, configure: Config.() -> Unit): Config
val key: AttributeKey<Config>

val ApplicationCall.callId: String?
fun Configuration.callIdMdc(name: String = "CallId"): Unit
fun ConditionsHolderBuilder.condition(predicate: ApplicationCall.(OutgoingContent) -> Boolean): Unit
val ApplicationCallPipeline.conversionService: ConversionService
val OutgoingContent.defaultVersions: List<Version>
fun Configuration.deflate(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
fun ConditionsHolderBuilder.excludeContentType(vararg mimeTypes: ContentType): Unit
fun Configuration.generate(length: Int = 64, dictionary: String = CALL_ID_DEFAULT_DICTIONARY): Unit
fun Configuration.gzip(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
fun Configuration.identity(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
kotlin.collections.List

fun List<ContentTypeWithQuality>.sortedByQuality(): List<ContentTypeWithQuality>

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.writeMultipleRanges(channelProducer: (LongRange) -> ByteReadChannel, ranges: List<LongRange>, fullLength: Long?, boundary: String, contentType: String): ByteReadChannel

fun ConditionsHolderBuilder.matchContentType(vararg mimeTypes: ContentType): Unit
var Configuration.maxAge: Duration
var Configuration.maxAge: Duration
var CookieConfiguration.maxAge: <ERROR CLASS>?
var Configuration.maxAgeDuration: <ERROR CLASS>
var Configuration.maxAgeDuration: <ERROR CLASS>
fun ConditionsHolderBuilder.minimumSize(minSize: Long): Unit
val ApplicationRequest.origin: RequestConnectionPoint
fun Headers.parseVersions(): List<Version>
fun Configuration.statusFile(vararg code: HttpStatusCode, filePattern: String): Unit
fun ApplicationCall.suitableCharset(defaultCharset: <ERROR CLASS> = Charsets.UTF_8): <ERROR CLASS>
fun ApplicationRequest.toLogString(): String
suspend fun ApplicationCall.withETag(etag: String, putHeader: Boolean = true, block: suspend () -> Unit): Unit

package io.ktor.http

fun HeadersBuilder.expires(expires: LocalDateTime): Unit
val httpDateFormat: DateTimeFormatter
val httpDateFormat0: DateTimeFormatter
java.time.temporal.Temporal

fun Temporal.toHttpDateString(): String
@JvmName("toHttpDateString") fun Temporal.toHttpDateString0(): String

kotlin.Long

fun Long.toHttpDateString(): String

kotlin.String

fun String.fromHttpDateString(): ZonedDateTime
@JvmName("fromHttpDateString") fun String.fromHttpDateString0(): ZonedDateTime

fun HeadersBuilder.lastModified(dateTime: ZonedDateTime): Unit
fun ApplicationResponse.link(header: LinkHeader): Unit
fun ApplicationResponse.link(uri: String, vararg rel: String): Unit
fun ApplicationCall.push(pathAndQuery: String): Unit
fun ApplicationCall.push(encodedPath: String, parameters: Parameters): Unit
fun ApplicationCall.push(block: ResponsePushBuilder.() -> Unit): Unit

package io.ktor.http.content

fun CachingOptions(cacheControl: CacheControl? = null, expires: ZonedDateTime): CachingOptions
enum class CompressedFileType

BROTLI
GZIP
val encoding: String
val extension: String
fun file(plain: File): File

class HttpStatusCodeContent : NoContent

HttpStatusCodeContent(value: HttpStatusCode)
val status: HttpStatusCode

class JarFileContent : ReadChannelContent

JarFileContent(zipFilePath: Path, resourcePath: String, contentType: ContentType)
JarFileContent(jarFile: File, resourcePath: String, contentType: ContentType)
val contentLength: Long?
val contentType: ContentType
val isFile: Boolean
val jarFile: File
fun readFrom(): ByteReadChannel
val resourcePath: String

fun LastModifiedVersion(lastModified: ZonedDateTime): LastModifiedVersion
fun LastModifiedVersion(lastModified: FileTime): LastModifiedVersion
class LocalFileContent : ReadChannelContent

LocalFileContent(file: File, contentType: ContentType = ContentType.defaultForFile(file))
val contentLength: Long
val contentType: ContentType
val file: File
fun readFrom(): ByteReadChannel
fun readFrom(range: LongRange): ByteReadChannel

fun LocalFileContent(baseDir: File, relativePath: String, contentType: ContentType = ContentType.defaultForFilePath(relativePath)): LocalFileContent
fun LocalFileContent(baseDir: Path, relativePath: Path, contentType: ContentType = ContentType.defaultForFile(relativePath)): LocalFileContent
fun Route.default(localPath: String): Unit
fun Route.default(localPath: File): Unit
fun Route.defaultResource(resource: String, resourcePackage: String? = null): Unit
fun Route.file(remotePath: String, localPath: String = remotePath): Unit
fun Route.file(remotePath: String, localPath: File): Unit
fun Route.files(folder: String): Unit
fun Route.files(folder: File): Unit
io.ktor.util.pipeline.PipelineContext

fun PipelineContext<Any, ApplicationCall>.transformDefaultContent(value: Any): OutgoingContent?

fun Route.preCompressed(vararg types: CompressedFileType = CompressedFileType.values(), configure: Route.() -> Unit): Unit
fun ApplicationCall.resolveResource(path: String, resourcePackage: String? = null, classLoader: ClassLoader = application.environment.classLoader, mimeResolve: (String) -> ContentType = { ContentType.defaultForFileExtension(it) }): OutgoingContent?
fun Route.resource(remotePath: String, resource: String = remotePath, resourcePackage: String? = null): Unit
fun resourceClasspathResource(url: URL, path: String, mimeResolve: (String) -> ContentType): OutgoingContent?
fun Route.resources(resourcePackage: String? = null): Unit
fun Route.static(configure: Route.() -> Unit): Route
fun Route.static(remotePath: String, configure: Route.() -> Unit): Route
var Route.staticBasePackage: String?
var Route.staticRootFolder: File?

package io.ktor.request

open class ApplicationReceivePipeline : Pipeline<ApplicationReceiveRequest, ApplicationCall>

ApplicationReceivePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val Transform: PipelinePhase
open val developmentMode: Boolean

class ApplicationReceiveRequest

ApplicationReceiveRequest(type: KClass<*>, value: Any)
ApplicationReceiveRequest(typeInfo: KType, value: Any, reusableValue: Boolean = false)
val reusableValue: Boolean
val type: KClass<*>
val typeInfo: KType
val value: Any

interface ApplicationRequest

abstract val call: ApplicationCall
abstract val cookies: RequestCookies
abstract val headers: Headers
abstract val local: RequestConnectionPoint
abstract val pipeline: ApplicationReceivePipeline
abstract val queryParameters: Parameters
abstract fun receiveChannel(): ByteReadChannel

typealias ContentTransformationException = ContentTransformationException
class RequestAlreadyConsumedException : IllegalStateException

RequestAlreadyConsumedException()

open class RequestCookies

RequestCookies(request: ApplicationRequest)
protected open fun fetchCookies(): Map<String, String>
operator fun get(name: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING): String?
val rawCookies: Map<String, String>
protected val request: ApplicationRequest

fun ApplicationRequest.accept(): String?
fun ApplicationRequest.acceptCharset(): String?
fun ApplicationRequest.acceptCharsetItems(): List<HeaderValue>
fun ApplicationRequest.acceptEncoding(): String?
fun ApplicationRequest.acceptEncodingItems(): List<HeaderValue>
fun ApplicationRequest.acceptItems(): List<HeaderValue>
fun ApplicationRequest.acceptLanguage(): String?
fun ApplicationRequest.acceptLanguageItems(): List<HeaderValue>
fun ApplicationRequest.authorization(): String?
fun ApplicationRequest.cacheControl(): String?
fun ApplicationRequest.contentCharset(): <ERROR CLASS>?
fun ApplicationRequest.contentType(): ContentType
fun ApplicationRequest.document(): String
fun ApplicationRequest.header(name: String): String?
fun ApplicationRequest.host(): String
val ApplicationRequest.httpMethod: HttpMethod
val ApplicationRequest.httpVersion: String
fun ApplicationRequest.isChunked(): Boolean
fun ApplicationRequest.isMultipart(): Boolean
fun ApplicationRequest.location(): String?
fun ApplicationRequest.path(): String
fun ApplicationRequest.port(): Int
fun ApplicationRequest.queryString(): String
fun ApplicationRequest.ranges(): RangesSpecifier?
inline suspend fun <reified T : Any> ApplicationCall.receive(): T
suspend fun <T : Any> ApplicationCall.receive(type: KClass<T>): T
suspend fun <T : Any> ApplicationCall.receive(type: KType): T
inline suspend fun ApplicationCall.receiveChannel(): ByteReadChannel
inline suspend fun ApplicationCall.receiveMultipart(): MultiPartData
inline suspend fun <reified T : Any> ApplicationCall.receiveOrNull(): T?
suspend fun <T : Any> ApplicationCall.receiveOrNull(type: KType): T?
suspend fun <T : Any> ApplicationCall.receiveOrNull(type: KClass<T>): T?
inline suspend fun ApplicationCall.receiveParameters(): Parameters
inline suspend fun ApplicationCall.receiveStream(): InputStream
inline suspend fun ApplicationCall.receiveText(): String
val ApplicationRequest.uri: String
fun ApplicationRequest.userAgent(): String?

package io.ktor.response

interface ApplicationResponse

abstract val call: ApplicationCall
abstract val cookies: ResponseCookies
abstract val headers: ResponseHeaders
abstract val pipeline: ApplicationSendPipeline
abstract fun push(builder: ResponsePushBuilder): Unit
abstract fun status(): HttpStatusCode?
abstract fun status(value: HttpStatusCode): Unit

open class ApplicationSendPipeline : Pipeline<Any, ApplicationCall>

ApplicationSendPipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val ContentEncoding: PipelinePhase
val Engine: PipelinePhase
val Render: PipelinePhase
val TransferEncoding: PipelinePhase
val Transform: PipelinePhase
open val developmentMode: Boolean

class DefaultResponsePushBuilder : ResponsePushBuilder

DefaultResponsePushBuilder(url: URLBuilder, headers: Headers)
DefaultResponsePushBuilder(call: ApplicationCall)
DefaultResponsePushBuilder(method: HttpMethod = HttpMethod.Get, url: URLBuilder = URLBuilder(), headers: HeadersBuilder = HeadersBuilder(), versions: List<Version> = emptyList())
val headers: HeadersBuilder
var method: HttpMethod
val url: URLBuilder
var versions: ArrayList<Version>

class ResponseCookies

ResponseCookies(response: ApplicationResponse, secureTransport: Boolean)
fun append(item: Cookie): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Long = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun appendExpired(name: String, domain: String? = null, path: String? = null): Unit
operator fun get(name: String): Cookie?

abstract class ResponseHeaders

ResponseHeaders()
fun allValues(): Headers
fun append(name: String, value: String, safeOnly: Boolean = true): Unit
operator fun contains(name: String): Boolean
protected abstract fun engineAppendHeader(name: String, value: String): Unit
open operator fun get(name: String): String?
protected abstract fun getEngineHeaderNames(): List<String>
protected abstract fun getEngineHeaderValues(name: String): List<String>
fun values(name: String): List<String>

interface ResponsePushBuilder

abstract val headers: HeadersBuilder
abstract var method: HttpMethod
abstract val url: URLBuilder
abstract val versions: MutableList<Version>

annotation class UseHttp2Push

UseHttp2Push()

fun ApplicationResponse.cacheControl(value: CacheControl): Unit
fun HeadersBuilder.cacheControl(value: CacheControl): Unit
fun HeadersBuilder.contentRange(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken): Unit
fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: RangeUnits): Unit
fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken): Unit
fun ApplicationCall.defaultTextContentType(contentType: ContentType?): ContentType
fun ApplicationResponse.etag(value: String): Unit
fun ApplicationResponse.expires(value: LocalDateTime): Unit
fun ApplicationResponse.header(name: String, value: String): Unit
fun ApplicationResponse.header(name: String, value: Int): Unit
fun ApplicationResponse.header(name: String, value: Long): Unit
fun ApplicationResponse.header(name: String, date: Temporal): Unit
fun ApplicationResponse.lastModified(dateTime: ZonedDateTime): Unit
@JvmName("respondWithType") inline suspend fun <reified T : Any> ApplicationCall.respond(message: T): Unit
inline suspend fun ApplicationCall.respond(message: Any): Unit
@JvmName("respondWithType") inline suspend fun <reified T : Any> ApplicationCall.respond(status: HttpStatusCode, message: T): Unit
inline suspend fun ApplicationCall.respond(status: HttpStatusCode, message: Any): Unit
suspend fun ApplicationCall.respondBytes(contentType: ContentType? = null, status: HttpStatusCode? = null, provider: suspend () -> ByteArray): Unit
suspend fun ApplicationCall.respondBytes(bytes: ByteArray, contentType: ContentType? = null, status: HttpStatusCode? = null, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondBytesWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, producer: suspend ByteWriteChannel.() -> Unit): Unit
suspend fun ApplicationCall.respondFile(baseDir: File, fileName: String, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondFile(file: File, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondOutputStream(contentType: ContentType? = null, status: HttpStatusCode? = null, producer: suspend OutputStream.() -> Unit): Unit
suspend fun ApplicationCall.respondRedirect(url: String, permanent: Boolean = false): Unit
inline suspend fun ApplicationCall.respondRedirect(permanent: Boolean = false, block: URLBuilder.() -> Unit): Unit
suspend fun ApplicationCall.respondText(text: String, contentType: ContentType? = null, status: HttpStatusCode? = null, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondText(contentType: ContentType? = null, status: HttpStatusCode? = null, provider: suspend () -> String): Unit
suspend fun ApplicationCall.respondTextWriter(contentType: ContentType? = null, status: HttpStatusCode? = null, writer: suspend Writer.() -> Unit): Unit
var ApplicationResponse.responseType: KType?

package io.ktor.routing

data class AndRouteSelector : RouteSelector

AndRouteSelector(first: RouteSelector, second: RouteSelector)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val first: RouteSelector
val second: RouteSelector
fun toString(): String

data class ConstantParameterRouteSelector : RouteSelector

ConstantParameterRouteSelector(name: String, value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String
val value: String

data class HostRouteSelector : RouteSelector

HostRouteSelector(hostList: List<String>, hostPatterns: List<Regex>, portsList: List<Int>)
const val HostNameParameter: String
const val PortParameter: String
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val hostList: List<String>
val hostPatterns: List<Regex>
val portsList: List<Int>
fun toString(): String

data class HttpAcceptRouteSelector : RouteSelector

HttpAcceptRouteSelector(contentType: ContentType)
val contentType: ContentType
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

data class HttpHeaderRouteSelector : RouteSelector

HttpHeaderRouteSelector(name: String, value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String
val value: String

data class HttpMethodRouteSelector : RouteSelector

HttpMethodRouteSelector(method: HttpMethod)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val method: HttpMethod
fun toString(): String

class IgnoreTrailingSlash

class Configuration

Configuration()

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, IgnoreTrailingSlash>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): IgnoreTrailingSlash
val key: AttributeKey<IgnoreTrailingSlash>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): IgnoreTrailingSlash
val key: AttributeKey<IgnoreTrailingSlash>

data class LocalPortRouteSelector : RouteSelector

LocalPortRouteSelector(port: Int)
const val LocalPortParameter: String
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val port: Int

data class OptionalParameterRouteSelector : RouteSelector

OptionalParameterRouteSelector(name: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String

data class OrRouteSelector : RouteSelector

OrRouteSelector(first: RouteSelector, second: RouteSelector)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val first: RouteSelector
val second: RouteSelector
fun toString(): String

data class ParameterRouteSelector : RouteSelector

ParameterRouteSelector(name: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
fun toString(): String

data class PathSegmentConstantRouteSelector : RouteSelector

PathSegmentConstantRouteSelector(value: String, hasTrailingSlash: Boolean)
PathSegmentConstantRouteSelector(value: String)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String
val value: String

data class PathSegmentOptionalParameterRouteSelector : RouteSelector

PathSegmentOptionalParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null, hasTrailingSlash: Boolean)
PathSegmentOptionalParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String?
val suffix: String?
fun toString(): String

data class PathSegmentParameterRouteSelector : RouteSelector

PathSegmentParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null, hasTrailingSlash: Boolean)
PathSegmentParameterRouteSelector(name: String, prefix: String? = null, suffix: String? = null)
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String?
val suffix: String?
fun toString(): String

object PathSegmentSelectorBuilder

fun parseConstant(value: String): RouteSelector
fun parseConstant(value: String, hasTrailingSlash: Boolean): RouteSelector
fun parseName(value: String): String
fun parseParameter(value: String): RouteSelector
fun parseParameter(value: String, hasTrailingSlash: Boolean): RouteSelector

data class PathSegmentTailcardRouteSelector : RouteSelector

PathSegmentTailcardRouteSelector(name: String = "", prefix: String = "", hasTrailingSlash: Boolean)
PathSegmentTailcardRouteSelector(name: String = "", prefix: String = "")
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val name: String
val prefix: String
fun toString(): String

object PathSegmentWildcardRouteSelector : RouteSelector

fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

class RootRouteSelector : RouteSelector

RootRouteSelector(rootPath: String = "")
fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
fun toString(): String

open class Route : ApplicationCallPipeline

Route(parent: Route?, selector: RouteSelector)
Route(parent: Route?, selector: RouteSelector, developmentMode: Boolean)
open fun afterIntercepted(): Unit
val children: List<Route>
fun createChild(selector: RouteSelector): Route
fun handle(handler: <ERROR CLASS><Unit, ApplicationCall>): Unit
operator fun invoke(body: Route.() -> Unit): Unit
val parent: Route?
val selector: RouteSelector
open fun toString(): String

abstract class RouteSelector

RouteSelector(quality: Double)
abstract fun evaluate(context: RoutingResolveContext, segmentIndex: Int): RouteSelectorEvaluation
val quality: Double

data class RouteSelectorEvaluation

RouteSelectorEvaluation(succeeded: Boolean, quality: Double, parameters: Parameters = Parameters.Empty, segmentIncrement: Int = 0)
val Constant: RouteSelectorEvaluation
val ConstantPath: RouteSelectorEvaluation
val Failed: RouteSelectorEvaluation
val Missing: RouteSelectorEvaluation
val WildcardPath: RouteSelectorEvaluation
val parameters: Parameters
val quality: Double
const val qualityConstant: Double
const val qualityMethodParameter: Double
const val qualityMissing: Double
const val qualityParameter: Double
const val qualityParameterWithPrefixOrSuffix: Double
const val qualityPathParameter: Double
const val qualityQueryParameter: Double
const val qualityTailcard: Double
const val qualityTransparent: Double
const val qualityWildcard: Double
val segmentIncrement: Int
val succeeded: Boolean

class Routing : Route

Routing(application: Application)
companion object Feature : ApplicationFeature<Application, Routing, Routing>

val RoutingCallFinished: EventDefinition<RoutingApplicationCall>
val RoutingCallStarted: EventDefinition<RoutingApplicationCall>
fun install(pipeline: Application, configure: Routing.() -> Unit): Routing
val key: AttributeKey<Routing>

val RoutingCallFinished: EventDefinition<RoutingApplicationCall>
val RoutingCallStarted: EventDefinition<RoutingApplicationCall>
val application: Application
fun install(pipeline: Application, configure: Routing.() -> Unit): Routing
suspend fun interceptor(context: PipelineContext<Unit, ApplicationCall>): Unit
val key: AttributeKey<Routing>
fun trace(block: (RoutingResolveTrace) -> Unit): Unit

class RoutingApplicationCall : ApplicationCall

RoutingApplicationCall(call: ApplicationCall, route: Route, receivePipeline: ApplicationReceivePipeline, responsePipeline: ApplicationSendPipeline, parameters: Parameters)
val application: Application
val attributes: Attributes
val parameters: Parameters
val request: RoutingApplicationRequest
val response: RoutingApplicationResponse
val route: Route
fun toString(): String

class RoutingApplicationRequest : ApplicationRequest

RoutingApplicationRequest(call: RoutingApplicationCall, pipeline: ApplicationReceivePipeline, request: ApplicationRequest)
val call: RoutingApplicationCall
val pipeline: ApplicationReceivePipeline

class RoutingApplicationResponse : ApplicationResponse

RoutingApplicationResponse(call: RoutingApplicationCall, pipeline: ApplicationSendPipeline, response: ApplicationResponse)
val call: RoutingApplicationCall
val pipeline: ApplicationSendPipeline

class RoutingPath

fun parse(path: String): RoutingPath
val parts: List<RoutingPathSegment>
val root: RoutingPath
fun toString(): String

data class RoutingPathSegment

RoutingPathSegment(value: String, kind: RoutingPathSegmentKind)
val kind: RoutingPathSegmentKind
val value: String

enum class RoutingPathSegmentKind

Constant
Parameter

class RoutingResolveContext

RoutingResolveContext(routing: Route, call: ApplicationCall, tracers: List<(RoutingResolveTrace) -> Unit>)
val call: ApplicationCall
val hasTrailingSlash: Boolean
fun resolve(): RoutingResolveResult
val routing: Route
val segments: List<String>

sealed class RoutingResolveResult

class Failure : RoutingResolveResult

Failure(route: Route, reason: String)
val parameters: Nothing
val reason: String
fun toString(): String

class Success : RoutingResolveResult

Success(route: Route, parameters: Parameters)
val parameters: Parameters
fun toString(): String

abstract val parameters: Parameters
val route: Route

class RoutingResolveTrace

RoutingResolveTrace(call: ApplicationCall, segments: List<String>)
fun begin(route: Route, segmentIndex: Int): Unit
fun buildText(): String
val call: ApplicationCall
fun finish(route: Route, segmentIndex: Int, result: RoutingResolveResult): Unit
val segments: List<String>
fun skip(route: Route, segmentIndex: Int, result: RoutingResolveResult): Unit
fun toString(): String

open class RoutingResolveTraceEntry

RoutingResolveTraceEntry(route: Route, segmentIndex: Int, result: RoutingResolveResult? = null)
fun append(item: RoutingResolveTraceEntry): Unit
open fun buildText(builder: StringBuilder, indent: Int): Unit
var result: RoutingResolveResult?
val route: Route
val segmentIndex: Int
open fun toString(): String

fun Route.accept(contentType: ContentType, build: Route.() -> Unit): Route
val Route.application: Application
fun Route.contentType(contentType: ContentType, build: Route.() -> Unit): Route
fun Route.createRouteFromPath(path: String): Route
fun Route.delete(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.delete(body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.get(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.get(body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.head(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.head(body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.header(name: String, value: String, build: Route.() -> Unit): Route
fun Route.host(host: String, port: Int = 0, build: Route.() -> Unit): Route
fun Route.host(hostPattern: Regex, port: Int = 0, build: Route.() -> Unit): Route
fun Route.host(hosts: List<String>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route
fun Route.host(hosts: List<String>, hostPatterns: List<Regex>, ports: List<Int> = emptyList(), build: Route.() -> Unit): Route
fun Route.localPort(port: Int, build: Route.() -> Unit): Route
fun Route.method(method: HttpMethod, body: Route.() -> Unit): Route
fun Route.optionalParam(name: String, build: Route.() -> Unit): Route
fun Route.options(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.options(body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.param(name: String, value: String, build: Route.() -> Unit): Route
fun Route.param(name: String, build: Route.() -> Unit): Route
fun Route.patch(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.patch(body: <ERROR CLASS><Unit, ApplicationCall>): Route
@JvmName("patchTyped") inline fun <reified R : Any> Route.patch(crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
@JvmName("patchTypedPath") inline fun <reified R : Any> Route.patch(path: String, crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
fun Route.port(vararg ports: Int, build: Route.() -> Unit): Route
fun Route.post(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
@JvmName("postTyped") inline fun <reified R : Any> Route.post(crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
@JvmName("postTypedPath") inline fun <reified R : Any> Route.post(path: String, crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
fun Route.post(body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.put(path: String, body: <ERROR CLASS><Unit, ApplicationCall>): Route
fun Route.put(body: <ERROR CLASS><Unit, ApplicationCall>): Route
@JvmName("putTyped") inline fun <reified R : Any> Route.put(crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
@JvmName("putTypedPath") inline fun <reified R : Any> Route.put(path: String, crossinline body: suspend PipelineContext<Unit, ApplicationCall>.(R) -> Unit): Route
fun Route.route(path: String, build: Route.() -> Unit): Route
fun Route.route(path: String, method: HttpMethod, build: Route.() -> Unit): Route
fun Application.routing(configuration: Routing.() -> Unit): Routing

package io.ktor.sessions

class CookieConfiguration

CookieConfiguration()
var domain: String?
var duration: TemporalAmount?
var encoding: CookieEncoding
val extensions: MutableMap<String, String?>
var httpOnly: Boolean
var maxAgeInSeconds: Long
var path: String?
var secure: Boolean

class CookieIdSessionBuilder<S : Any> : CookieSessionBuilder<S>

CookieIdSessionBuilder(type: KClass<S>)
fun identity(f: () -> String): Unit
var sessionIdProvider: () -> String

open class CookieSessionBuilder<S : Any>

CookieSessionBuilder(type: KClass<S>)
val cookie: CookieConfiguration
var serializer: SessionSerializer<S>
fun transform(transformer: SessionTransportTransformer): Unit
val transformers: List<SessionTransportTransformer>
val type: KClass<S>
val typeInfo: KType

interface CurrentSession

abstract fun clear(name: String): Unit
abstract fun findName(type: KClass<*>): String
abstract fun get(name: String): Any?
abstract fun set(name: String, value: Any?): Unit

const val DEFAULT_SESSION_MAX_AGE: Long
class HeaderIdSessionBuilder<S : Any> : HeaderSessionBuilder<S>

HeaderIdSessionBuilder(type: KClass<S>)
fun identity(f: () -> String): Unit
var sessionIdProvider: () -> String

open class HeaderSessionBuilder<S : Any>

HeaderSessionBuilder(type: KClass<S>)
var serializer: SessionSerializer<S>
fun transform(transformer: SessionTransportTransformer): Unit
val transformers: List<SessionTransportTransformer>
val type: KClass<S>
val typeInfo: KType

class SessionNotYetConfiguredException : IllegalStateException

SessionNotYetConfiguredException()

class SessionProvider<S : Any>

SessionProvider(name: String, type: KClass<S>, transport: SessionTransport, tracker: SessionTracker<S>)
val name: String
fun toString(): String
val tracker: SessionTracker<S>
val transport: SessionTransport
val type: KClass<S>

interface SessionSerializer<T>

abstract fun deserialize(text: String): T
abstract fun serialize(session: T): String

class SessionSerializerReflection<T : Any> : SessionSerializer<T>

SessionSerializerReflection(type: KClass<T>)
fun deserialize(text: String): T
fun serialize(session: T): String
val type: KClass<T>

interface SessionStorage

abstract suspend fun invalidate(id: String): Unit
abstract suspend fun <R> read(id: String, consumer: suspend (ByteReadChannel) -> R): R
abstract suspend fun write(id: String, provider: suspend (ByteWriteChannel) -> Unit): Unit

class SessionStorageMemory : SessionStorage

SessionStorageMemory()
suspend fun invalidate(id: String): Unit
suspend fun <R> read(id: String, consumer: suspend (ByteReadChannel) -> R): R
suspend fun write(id: String, provider: suspend (ByteWriteChannel) -> Unit): Unit

interface SessionTracker<S : Any>

abstract suspend fun clear(call: ApplicationCall): Unit
abstract suspend fun load(call: ApplicationCall, transport: String?): S?
abstract suspend fun store(call: ApplicationCall, value: S): String
abstract fun validate(value: S): Unit

class SessionTrackerById<S : Any> : SessionTracker<S>

SessionTrackerById(type: KClass<S>, serializer: SessionSerializer<S>, storage: SessionStorage, sessionIdProvider: () -> String)
suspend fun clear(call: ApplicationCall): Unit
suspend fun load(call: ApplicationCall, transport: String?): S?
val serializer: SessionSerializer<S>
val sessionIdProvider: () -> String
val storage: SessionStorage
suspend fun store(call: ApplicationCall, value: S): String
fun toString(): String
val type: KClass<S>
fun validate(value: S): Unit

class SessionTrackerByValue<S : Any> : SessionTracker<S>

SessionTrackerByValue(type: KClass<S>, serializer: SessionSerializer<S>)
suspend fun clear(call: ApplicationCall): Unit
suspend fun load(call: ApplicationCall, transport: String?): S?
val serializer: SessionSerializer<S>
suspend fun store(call: ApplicationCall, value: S): String
fun toString(): String
val type: KClass<S>
fun validate(value: S): Unit

interface SessionTransport

abstract fun clear(call: ApplicationCall): Unit
abstract fun receive(call: ApplicationCall): String?
abstract fun send(call: ApplicationCall, value: String): Unit

class SessionTransportCookie : SessionTransport

SessionTransportCookie(name: String, configuration: CookieConfiguration, transformers: List<SessionTransportTransformer>)
fun clear(call: ApplicationCall): Unit
val configuration: CookieConfiguration
val name: String
fun receive(call: ApplicationCall): String?
fun send(call: ApplicationCall, value: String): Unit
fun toString(): String
val transformers: List<SessionTransportTransformer>

class SessionTransportHeader : SessionTransport

SessionTransportHeader(name: String, transformers: List<SessionTransportTransformer>)
fun clear(call: ApplicationCall): Unit
val name: String
fun receive(call: ApplicationCall): String?
fun send(call: ApplicationCall, value: String): Unit
fun toString(): String
val transformers: List<SessionTransportTransformer>

interface SessionTransportTransformer

abstract fun transformRead(transportValue: String): String?
abstract fun transformWrite(transportValue: String): String

class SessionTransportTransformerDigest : SessionTransportTransformer

SessionTransportTransformerDigest(salt: String = "ktor", algorithm: String = "SHA-384")
val algorithm: String
val salt: String
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class SessionTransportTransformerEncrypt : SessionTransportTransformer

SessionTransportTransformerEncrypt(encryptionKey: ByteArray, signKey: ByteArray, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = "AES", signAlgorithm: String = "HmacSHA256")
SessionTransportTransformerEncrypt(encryptionKeySpec: SecretKeySpec, signKeySpec: SecretKeySpec, ivGenerator: (size: Int) -> ByteArray = { size -> ByteArray(size).apply { SecureRandom().nextBytes(this) } }, encryptAlgorithm: String = encryptionKeySpec.algorithm, signAlgorithm: String = signKeySpec.algorithm)
val encryptAlgorithm: String
val encryptionKeySize: Int
val encryptionKeySpec: SecretKeySpec
val ivGenerator: (size: Int) -> ByteArray
val signAlgorithm: String
val signKeySpec: SecretKeySpec
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class SessionTransportTransformerMessageAuthentication : SessionTransportTransformer

SessionTransportTransformerMessageAuthentication(key: ByteArray, algorithm: String = "HmacSHA256")
SessionTransportTransformerMessageAuthentication(keySpec: SecretKeySpec, algorithm: String = "HmacSHA256")
val algorithm: String
val keySpec: SecretKeySpec
fun transformRead(transportValue: String): String?
fun transformWrite(transportValue: String): String

class Sessions

Sessions(providers: List<SessionProvider<*>>)
class Configuration

Configuration()
val providers: List<SessionProvider<*>>
fun register(provider: SessionProvider<*>): Unit

companion object Feature : ApplicationFeature<ApplicationCallPipeline, Configuration, Sessions>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Sessions
val key: AttributeKey<Sessions>

fun install(pipeline: ApplicationCallPipeline, configure: Configuration.() -> Unit): Sessions
val key: AttributeKey<Sessions>
val providers: List<SessionProvider<*>>

class TooLateSessionSetException : IllegalStateException

TooLateSessionSetException()

inline fun <reified T : Any> autoSerializerOf(): SessionSerializerReflection<T>
fun <T : Any> autoSerializerOf(type: KClass<T>): SessionSerializerReflection<T>
inline fun <reified T> CurrentSession.clear(): Unit
fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit): Unit
fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>): Unit
inline fun <reified S : Any> Configuration.cookie(name: String): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, block: CookieSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, block: CookieSessionBuilder<S>.() -> Unit): Unit
inline fun <reified T : Any> defaultSessionSerializer(): SessionSerializer<T>
fun <T : Any> defaultSessionSerializer(typeInfo: KType): SessionSerializer<T>
var CookieConfiguration.duration: TemporalAmount?
fun generateSessionId(): String
inline fun <reified T> CurrentSession.get(): T?
inline fun <reified T> CurrentSession.getOrSet(name: String = findName(T::class), generator: () -> T): T
fun <S : Any> Configuration.header(name: String, sessionType: KClass<S>, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.header(name: String, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.header(name: String, storage: SessionStorage, block: HeaderIdSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.header(name: String, sessionType: KClass<S>, storage: SessionStorage, block: HeaderIdSessionBuilder<S>.() -> Unit): Unit
fun <S : Any> Configuration.header(name: String, sessionType: KClass<S>): Unit
inline fun <reified S : Any> Configuration.header(name: String): Unit
inline fun <reified S : Any> Configuration.header(name: String, block: HeaderSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.header(name: String, sessionType: KClass<S>, block: HeaderSessionBuilder<S>.() -> Unit): Unit
kotlin.collections.List

fun List<SessionTransportTransformer>.transformRead(cookieValue: String?): String?
fun List<SessionTransportTransformer>.transformWrite(value: String): String

inline fun <reified SessionType : Any> ApplicationCall.sessionId(): String?
val ApplicationCall.sessionId: String?
val ApplicationCall.sessions: CurrentSession
inline fun <reified T> CurrentSession.set(value: T?): Unit

package io.ktor.util

interface ConversionService

abstract fun fromValues(values: List<String>, type: Type): Any?
abstract fun toValues(value: Any?): List<String>

class CopyOnWriteHashMap<K : Any, V : Any>

CopyOnWriteHashMap()
fun computeIfAbsent(key: K, producer: (key: K) -> V): V
operator fun get(key: K): V?
fun put(key: K, value: V): V?
fun remove(key: K): V?
operator fun set(key: K, value: V): Unit

class DataConversionException : DataConversionException

DataConversionException(message: String = "Invalid data format")

object DefaultConversionService : ConversionService

fun fromValues(values: List<String>, type: Type): Any
fun toValues(value: Any?): List<String>

class DispatcherWithShutdown : CoroutineDispatcher

DispatcherWithShutdown(delegate: CoroutineDispatcher)
fun completeShutdown(): Unit
fun dispatch(context: <ERROR CLASS>, block: Runnable): Unit
fun isDispatchNeeded(context: <ERROR CLASS>): Boolean
fun prepareShutdown(): Unit

val GreenwichMeanTime: ZoneId
fun URLBuilder.Companion.createFromCall(call: ApplicationCall): URLBuilder
inline fun Parameters.getOrFail(name: String): String
inline operator fun <reified R : Any> Parameters.getValue(thisRef: Any?, property: KProperty<*>): R
java.util.Date

fun Date.toLocalDateTime(): LocalDateTime
fun Date.toZonedDateTime(): ZonedDateTime

kotlin.collections.List

fun List<String>.normalizePathComponents(): List<String>

fun url(block: URLBuilder.() -> Unit): String
inline fun ApplicationCall.url(block: URLBuilder.() -> Unit = {}): String

package io.ktor.util.date

java.time.Instant

fun Instant.toGMTDate(): GMTDate

java.time.ZonedDateTime

fun ZonedDateTime.toGMTDate(): GMTDate