ktor-http-cio/io.ktor.http.cio.internals/WeakTimeoutQueue

WeakTimeoutQueue

class WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long)

It provides ability to cancel jobs and schedule coroutine with timeout. Unlike regular withTimeout this implementation is never scheduling timer tasks but only checks for current time. This makes timeout measurement much cheaper and doesn't require any watchdog thread.

There are two limitations:

timeout period is fixed
job cancellation is not guaranteed if no new jobs scheduled

The last one limitation is generally unacceptable however in the particular use-case (closing IDLE connection) it is just fine as we really don't care about stalling IDLE connections if there are no more incoming

Constructors

WeakTimeoutQueue

fun WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long = { System.currentTimeMillis() })

Types

Registration

interface Registration : Function1<cause: Throwable?, Unit> , DisposableHandle

Functions

cancel

fun cancel()

Cancel all registered timeouts

process

fun process()

Process and cancel all jobs that are timed out

fun register(job: Job): WeakTimeoutQueue.Registration

withTimeout

suspend fun <T> withTimeout(block: suspend CoroutineScope.() -> T): T

Execute block and cancel if doesn't complete in time. Unlike the regular kotlinx.coroutines withTimeout, this also checks for cancellation first and fails immediately.

Properties

timeoutMillis

val timeoutMillis: Long