ktor-server-cio/io.ktor.server.cio.internal/WeakTimeoutQueue

WeakTimeoutQueue

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

actual 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

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

Constructors

WeakTimeoutQueue

expect fun WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long = { GMTDate().timestamp })

actual fun WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long = { GMTDate().timestamp })

Functions

cancel

expect fun cancel()

actual fun cancel()

Cancel all registered timeouts.

actual fun cancel()

process

expect fun process()

actual fun process()

Process and cancel all jobs that are timed out

actual fun process()

withTimeout

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

actual 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

expect val timeoutMillis: Long

actual val timeoutMillis: Long