ktor-server-host-common

alltypes

interface ApplicationEngine

open class Configuration

Configuration()
var callGroupSize: Int
var connectionGroupSize: Int
val parallelism: Int
var workerGroupSize: Int

open val application: Application
abstract val environment: ApplicationEngineEnvironment
abstract fun start(wait: Boolean = false): ApplicationEngine
open fun stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit): Unit
abstract fun stop(gracePeriodMillis: Long, timeoutMillis: Long): Unit

interface ApplicationEngineEnvironment : ApplicationEnvironment

abstract val application: Application
abstract val connectors: List<EngineConnectorConfig>
abstract fun start(): Unit
abstract fun stop(): Unit

class ApplicationEngineEnvironmentBuilder

ApplicationEngineEnvironmentBuilder()
fun build(builder: ApplicationEngineEnvironmentBuilder.() -> Unit): ApplicationEngineEnvironment
var classLoader: ClassLoader
var config: ApplicationConfig
val connectors: MutableList<EngineConnectorConfig>
var developmentMode: Boolean
var log: Logger
fun module(body: Application.() -> Unit): Unit
val modules: MutableList<Application.() -> Unit>
var parentCoroutineContext: <ERROR CLASS>
var rootPath: String
var watchPaths: List<String>

class ApplicationEngineEnvironmentReloading : ApplicationEngineEnvironment

ApplicationEngineEnvironmentReloading(classLoader: ClassLoader, log: Logger, config: ApplicationConfig, connectors: List<EngineConnectorConfig>, modules: List<Application.() -> Unit>, watchPaths: List<String> = emptyList(), parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext, rootPath: String = "")
ApplicationEngineEnvironmentReloading(classLoader: ClassLoader, log: Logger, config: ApplicationConfig, connectors: List<EngineConnectorConfig>, modules: List<Application.() -> Unit>, watchPaths: List<String> = emptyList(), parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext, rootPath: String = "", developmentMode: Boolean = true)
val application: Application
val classLoader: ClassLoader
val config: ApplicationConfig
val connectors: List<EngineConnectorConfig>
val developmentMode: Boolean
val log: Logger
val monitor: ApplicationEvents
val parentCoroutineContext: <ERROR CLASS>
fun reload(): Unit
val rootPath: String
fun start(): Unit
fun stop(): Unit

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

abstract fun create(environment: ApplicationEngineEnvironment, configure: TConfiguration.() -> Unit): TEngine

abstract class BaseApplicationCall : ApplicationCall

BaseApplicationCall(application: Application)
val application: Application
val attributes: Attributes
open val parameters: Parameters
protected fun putResponseAttribute(response: BaseApplicationResponse = this.response): Unit
abstract val request: BaseApplicationRequest
abstract val response: BaseApplicationResponse

abstract class BaseApplicationEngine : ApplicationEngine

BaseApplicationEngine(environment: ApplicationEngineEnvironment, pipeline: EnginePipeline = defaultEnginePipeline(environment))
open class Configuration : Configuration

Configuration()

val environment: ApplicationEngineEnvironment
val pipeline: EnginePipeline

abstract class BaseApplicationRequest : ApplicationRequest

BaseApplicationRequest(call: ApplicationCall)
val call: ApplicationCall
open val pipeline: ApplicationReceivePipeline

abstract class BaseApplicationResponse : ApplicationResponse

BaseApplicationResponse(call: ApplicationCall)
class BodyLengthIsTooLong : IllegalStateException, CopyableThrowable<BodyLengthIsTooLong>

BodyLengthIsTooLong(expected: Long)
fun createCopy(): BodyLengthIsTooLong?

class BodyLengthIsTooSmall : IllegalStateException, CopyableThrowable<BodyLengthIsTooSmall>

BodyLengthIsTooSmall(expected: Long, actual: Long)
fun createCopy(): BodyLengthIsTooSmall?

val EngineResponseAtributeKey: AttributeKey<BaseApplicationResponse>
class InvalidHeaderForContent : IllegalStateException, CopyableThrowable<InvalidHeaderForContent>

InvalidHeaderForContent(name: String, content: String)
fun createCopy(): InvalidHeaderForContent?

class ResponseAlreadySentException : IllegalStateException

ResponseAlreadySentException()

protected open val bufferPool: ObjectPool<ByteBuffer>
val call: ApplicationCall
protected fun commitHeaders(content: OutgoingContent): Unit
open val cookies: ResponseCookies
val pipeline: ApplicationSendPipeline
open fun push(builder: ResponsePushBuilder): Unit
protected open suspend fun respondFromBytes(bytes: ByteArray): Unit
protected open suspend fun respondFromChannel(readChannel: ByteReadChannel): Unit
protected open suspend fun respondNoContent(content: NoContent): Unit
protected open suspend fun respondOutgoingContent(content: OutgoingContent): Unit
protected abstract suspend fun respondUpgrade(upgrade: ProtocolUpgrade): Unit
protected open suspend fun respondWriteChannelContent(content: WriteChannelContent): Unit
protected abstract suspend fun responseChannel(): ByteWriteChannel
protected abstract fun setStatus(statusCode: HttpStatusCode): Unit
fun setupSendPipeline(sendPipeline: ApplicationSendPipeline): Unit
open fun status(): HttpStatusCode?
open fun status(value: HttpStatusCode): Unit

data class ConnectorType

ConnectorType(name: String)
val HTTP: ConnectorType
val HTTPS: ConnectorType
val name: String

class DefaultUncaughtExceptionHandler : CoroutineExceptionHandler

DefaultUncaughtExceptionHandler(logger: Logger)
DefaultUncaughtExceptionHandler(logger: () -> Logger)
fun handleException(context: <ERROR CLASS>, exception: Throwable): Unit
val key: <ERROR CLASS><out <ERROR CLASS>>

annotation class EngineAPI

EngineAPI()

open class EngineConnectorBuilder : EngineConnectorConfig

EngineConnectorBuilder(type: ConnectorType = ConnectorType.HTTP)
open var host: String
open var port: Int
open fun toString(): String
open val type: ConnectorType

interface EngineConnectorConfig

abstract val host: String
abstract val port: Int
abstract val type: ConnectorType

class EnginePipeline : Pipeline<Unit, ApplicationCall>

EnginePipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Call: PipelinePhase
val developmentMode: Boolean
val receivePipeline: ApplicationReceivePipeline
val sendPipeline: ApplicationSendPipeline

class EngineSSLConnectorBuilder : EngineConnectorBuilder, EngineSSLConnectorConfig

EngineSSLConnectorBuilder(keyStore: KeyStore, keyAlias: String, keyStorePassword: () -> CharArray, privateKeyPassword: () -> CharArray)
var keyAlias: String
var keyStore: KeyStore
var keyStorePassword: () -> CharArray
var keyStorePath: File?
val privateKeyPassword: () -> CharArray

interface EngineSSLConnectorConfig : EngineConnectorConfig

abstract val keyAlias: String
abstract val keyStore: KeyStore
abstract val keyStorePassword: () -> CharArray
abstract val keyStorePath: File?
abstract val privateKeyPassword: () -> CharArray

class ShutDownUrl

ShutDownUrl(url: String, exitCode: ApplicationCall.() -> Int)
object ApplicationCallFeature : ApplicationFeature<ApplicationCallPipeline, Configuration, ShutDownUrl>

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

class Configuration

Configuration()
var exitCodeSupplier: ApplicationCall.() -> Int
var shutDownUrl: String

object EngineFeature : ApplicationFeature<EnginePipeline, Configuration, ShutDownUrl>

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

suspend fun doShutdown(call: ApplicationCall): Unit
val exitCode: ApplicationCall.() -> Int
val url: String

io.ktor.request.ApplicationReceivePipeline

fun ApplicationReceivePipeline.installDefaultTransformations(): Unit

io.ktor.response.ApplicationSendPipeline

fun ApplicationSendPipeline.installDefaultTransformations(): Unit

kotlinx.coroutines.CoroutineScope

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

kotlinx.coroutines.Job

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

package io.ktor.server.engine

interface ApplicationEngine

open class Configuration

Configuration()
var callGroupSize: Int
var connectionGroupSize: Int
val parallelism: Int
var workerGroupSize: Int

open val application: Application
abstract val environment: ApplicationEngineEnvironment
abstract fun start(wait: Boolean = false): ApplicationEngine
open fun stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit): Unit
abstract fun stop(gracePeriodMillis: Long, timeoutMillis: Long): Unit

interface ApplicationEngineEnvironment : ApplicationEnvironment

abstract val application: Application
abstract val connectors: List<EngineConnectorConfig>
abstract fun start(): Unit
abstract fun stop(): Unit

class ApplicationEngineEnvironmentBuilder

ApplicationEngineEnvironmentBuilder()
fun build(builder: ApplicationEngineEnvironmentBuilder.() -> Unit): ApplicationEngineEnvironment
var classLoader: ClassLoader
var config: ApplicationConfig
val connectors: MutableList<EngineConnectorConfig>
var developmentMode: Boolean
var log: Logger
fun module(body: Application.() -> Unit): Unit
val modules: MutableList<Application.() -> Unit>
var parentCoroutineContext: <ERROR CLASS>
var rootPath: String
var watchPaths: List<String>

class ApplicationEngineEnvironmentReloading : ApplicationEngineEnvironment

ApplicationEngineEnvironmentReloading(classLoader: ClassLoader, log: Logger, config: ApplicationConfig, connectors: List<EngineConnectorConfig>, modules: List<Application.() -> Unit>, watchPaths: List<String> = emptyList(), parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext, rootPath: String = "")
ApplicationEngineEnvironmentReloading(classLoader: ClassLoader, log: Logger, config: ApplicationConfig, connectors: List<EngineConnectorConfig>, modules: List<Application.() -> Unit>, watchPaths: List<String> = emptyList(), parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext, rootPath: String = "", developmentMode: Boolean = true)
val application: Application
val classLoader: ClassLoader
val config: ApplicationConfig
val connectors: List<EngineConnectorConfig>
val developmentMode: Boolean
val log: Logger
val monitor: ApplicationEvents
val parentCoroutineContext: <ERROR CLASS>
fun reload(): Unit
val rootPath: String
fun start(): Unit
fun stop(): Unit

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

abstract fun create(environment: ApplicationEngineEnvironment, configure: TConfiguration.() -> Unit): TEngine

abstract class BaseApplicationCall : ApplicationCall

BaseApplicationCall(application: Application)
val application: Application
val attributes: Attributes
open val parameters: Parameters
protected fun putResponseAttribute(response: BaseApplicationResponse = this.response): Unit
abstract val request: BaseApplicationRequest
abstract val response: BaseApplicationResponse

abstract class BaseApplicationEngine : ApplicationEngine

BaseApplicationEngine(environment: ApplicationEngineEnvironment, pipeline: EnginePipeline = defaultEnginePipeline(environment))
open class Configuration : Configuration

Configuration()

val environment: ApplicationEngineEnvironment
val pipeline: EnginePipeline

abstract class BaseApplicationRequest : ApplicationRequest

BaseApplicationRequest(call: ApplicationCall)
val call: ApplicationCall
open val pipeline: ApplicationReceivePipeline

abstract class BaseApplicationResponse : ApplicationResponse

BaseApplicationResponse(call: ApplicationCall)
class BodyLengthIsTooLong : IllegalStateException, CopyableThrowable<BodyLengthIsTooLong>

BodyLengthIsTooLong(expected: Long)
fun createCopy(): BodyLengthIsTooLong?

class BodyLengthIsTooSmall : IllegalStateException, CopyableThrowable<BodyLengthIsTooSmall>

BodyLengthIsTooSmall(expected: Long, actual: Long)
fun createCopy(): BodyLengthIsTooSmall?

val EngineResponseAtributeKey: AttributeKey<BaseApplicationResponse>
class InvalidHeaderForContent : IllegalStateException, CopyableThrowable<InvalidHeaderForContent>

InvalidHeaderForContent(name: String, content: String)
fun createCopy(): InvalidHeaderForContent?

class ResponseAlreadySentException : IllegalStateException

ResponseAlreadySentException()

protected open val bufferPool: ObjectPool<ByteBuffer>
val call: ApplicationCall
protected fun commitHeaders(content: OutgoingContent): Unit
open val cookies: ResponseCookies
val pipeline: ApplicationSendPipeline
open fun push(builder: ResponsePushBuilder): Unit
protected open suspend fun respondFromBytes(bytes: ByteArray): Unit
protected open suspend fun respondFromChannel(readChannel: ByteReadChannel): Unit
protected open suspend fun respondNoContent(content: NoContent): Unit
protected open suspend fun respondOutgoingContent(content: OutgoingContent): Unit
protected abstract suspend fun respondUpgrade(upgrade: ProtocolUpgrade): Unit
protected open suspend fun respondWriteChannelContent(content: WriteChannelContent): Unit
protected abstract suspend fun responseChannel(): ByteWriteChannel
protected abstract fun setStatus(statusCode: HttpStatusCode): Unit
fun setupSendPipeline(sendPipeline: ApplicationSendPipeline): Unit
open fun status(): HttpStatusCode?
open fun status(value: HttpStatusCode): Unit

data class ConnectorType

ConnectorType(name: String)
val HTTP: ConnectorType
val HTTPS: ConnectorType
val name: String

class DefaultUncaughtExceptionHandler : CoroutineExceptionHandler

DefaultUncaughtExceptionHandler(logger: Logger)
DefaultUncaughtExceptionHandler(logger: () -> Logger)
fun handleException(context: <ERROR CLASS>, exception: Throwable): Unit
val key: <ERROR CLASS><out <ERROR CLASS>>

annotation class EngineAPI

EngineAPI()

open class EngineConnectorBuilder : EngineConnectorConfig

EngineConnectorBuilder(type: ConnectorType = ConnectorType.HTTP)
open var host: String
open var port: Int
open fun toString(): String
open val type: ConnectorType

interface EngineConnectorConfig

abstract val host: String
abstract val port: Int
abstract val type: ConnectorType

class EnginePipeline : Pipeline<Unit, ApplicationCall>

EnginePipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Call: PipelinePhase
val developmentMode: Boolean
val receivePipeline: ApplicationReceivePipeline
val sendPipeline: ApplicationSendPipeline

class EngineSSLConnectorBuilder : EngineConnectorBuilder, EngineSSLConnectorConfig

EngineSSLConnectorBuilder(keyStore: KeyStore, keyAlias: String, keyStorePassword: () -> CharArray, privateKeyPassword: () -> CharArray)
var keyAlias: String
var keyStore: KeyStore
var keyStorePassword: () -> CharArray
var keyStorePath: File?
val privateKeyPassword: () -> CharArray

interface EngineSSLConnectorConfig : EngineConnectorConfig

abstract val keyAlias: String
abstract val keyStore: KeyStore
abstract val keyStorePassword: () -> CharArray
abstract val keyStorePath: File?
abstract val privateKeyPassword: () -> CharArray

class ShutDownUrl

ShutDownUrl(url: String, exitCode: ApplicationCall.() -> Int)
object ApplicationCallFeature : ApplicationFeature<ApplicationCallPipeline, Configuration, ShutDownUrl>

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

class Configuration

Configuration()
var exitCodeSupplier: ApplicationCall.() -> Int
var shutDownUrl: String

object EngineFeature : ApplicationFeature<EnginePipeline, Configuration, ShutDownUrl>

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

suspend fun doShutdown(call: ApplicationCall): Unit
val exitCode: ApplicationCall.() -> Int
val url: String

fun ApplicationEngine.addShutdownHook(stop: () -> Unit): Unit
fun applicationEngineEnvironment(builder: ApplicationEngineEnvironmentBuilder.() -> Unit): ApplicationEngineEnvironment
fun commandLineEnvironment(args: Array<String>): ApplicationEngineEnvironment
inline fun ApplicationEngineEnvironmentBuilder.connector(builder: EngineConnectorBuilder.() -> Unit): Unit
fun defaultEnginePipeline(environment: ApplicationEnvironment): EnginePipeline
fun defaultExceptionStatusCode(cause: Throwable): HttpStatusCode?
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = listOf(WORKING_DIRECTORY_PATH), configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit): TEngine
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, environment: ApplicationEngineEnvironment, configure: TConfiguration.() -> Unit = {}): TEngine
suspend fun handleFailure(call: ApplicationCall, error: Throwable): Unit
io.ktor.request.ApplicationReceivePipeline

fun ApplicationReceivePipeline.installDefaultTransformations(): Unit

io.ktor.response.ApplicationSendPipeline

fun ApplicationSendPipeline.installDefaultTransformations(): Unit

kotlinx.coroutines.CoroutineScope

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

kotlinx.coroutines.Job

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

fun Configuration.loadCommonConfiguration(deploymentConfig: ApplicationConfig): Unit
suspend fun logError(call: ApplicationCall, error: Throwable): Unit
inline fun ApplicationEngineEnvironmentBuilder.sslConnector(keyStore: KeyStore, keyAlias: String, noinline keyStorePassword: () -> CharArray, noinline privateKeyPassword: () -> CharArray, builder: EngineSSLConnectorBuilder.() -> Unit): Unit
fun ApplicationEngine.stop(gracePeriod: Long, timeout: Long, timeUnit: TimeUnit): Unit
fun ApplicationEngine.stopServerOnCancellation(): CompletableJob