ktor-server-netty/io.ktor.server.netty

Package-level declarations

Types

Netty engine

class EventLoopGroupProxy(val channel: KClass<out ServerSocketChannel>, group: EventLoopGroup) : EventLoopGroup

Transparently allows for the creation of EventLoopGroup's utilising the optimal implementation for a given operating system, subject to availability, or falling back to NioEventLoopGroup if none is available.

Netty

object Netty : ApplicationEngineFactory<NettyApplicationEngine, NettyApplicationEngine.Configuration>

An ApplicationEngineFactory providing a Netty-based ApplicationEngine

NettyApplicationCall

abstract class NettyApplicationCall(application: Application, val context: ChannelHandlerContext, requestMessage: Any) : BaseApplicationCall

NettyApplicationEngine

class NettyApplicationEngine(environment: ApplicationEngineEnvironment, configure: NettyApplicationEngine.Configuration.() -> Unit = {}) : BaseApplicationEngine

ApplicationEngine implementation for running in a standalone Netty

NettyApplicationRequest

abstract class NettyApplicationRequest(call: ApplicationCall, val coroutineContext: CoroutineContext, val context: ChannelHandlerContext, requestBodyChannel: ByteReadChannel, uri: String, keepAlive: Boolean) : BaseApplicationRequest, CoroutineScope

NettyApplicationRequestHeaders

class NettyApplicationRequestHeaders(request: HttpRequest) : Headers

NettyApplicationResponse

abstract class NettyApplicationResponse(call: NettyApplicationCall, context: ChannelHandlerContext, engineContext: CoroutineContext, userContext: CoroutineContext) : BaseApplicationResponse

NettyChannelInitializer

class NettyChannelInitializer(enginePipeline: EnginePipeline, environment: ApplicationEngineEnvironment, callEventGroup: EventExecutorGroup, engineContext: CoroutineContext, userContext: CoroutineContext, connector: EngineConnectorConfig, requestQueueLimit: Int, runningLimit: Int, responseWriteTimeout: Int, requestReadTimeout: Int, httpServerCodec: () -> HttpServerCodec, channelPipelineConfig: ChannelPipeline.() -> Unit) : ChannelInitializer<SocketChannel>

A ChannelInitializer implementation that does setup the default ktor channel pipeline

Functions

suspendAwait

suspend fun <T> Future<T>.suspendAwait(): T

Suspend until the future completion. Resumes with the same exception if the future completes exceptionally

suspend fun <T> Future<T>.suspendAwait(exception: (Throwable, Continuation<T>) -> Unit): T

Suspend until the future completion handling exception from the future using exception function

suspendWriteAwait

suspend fun <T> Future<T>.suspendWriteAwait(): T

Suspend until the future completion. Wraps futures completion exceptions into ChannelWriteException