ktor-server-cio/io.ktor.server.cio.backend/ServerRequestScope

ServerRequestScope

class ServerRequestScope : CoroutineScope(source)

Represents a request scope.

Report a problem

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

val input: ByteReadChannel

channel connected to request body bytes stream

val localAddress: NetworkAddress?

on which the client was accepted (if known)

val output: ByteWriteChannel

channel connected to response body

val remoteAddress: NetworkAddress?

of the client (if known)

val upgraded: CompletableDeferred<Boolean>?

deferred should be completed on upgrade request

Functions

fun CoroutineScope.httpServer(settings: HttpServerSettings, handler: HttpRequestHandler): HttpServer

Start an http server with settings invoking handler for every request

startServerConnectionPipeline

fun CoroutineScope.startServerConnectionPipeline(connection: ServerIncomingConnection, timeout: Duration, handler: HttpRequestHandler): Job

Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature

unixSocketServer

fun CoroutineScope.unixSocketServer(settings: UnixSocketServerSettings, handler: HttpRequestHandler): HttpServer

Start an http server with settings invoking handler for every request

fun withContext(coroutineContext: CoroutineContext): ServerRequestScope

Creates another request scope with same parameters except coroutine context