ksrpc-api/com.monkopedia.ksrpc.annotation/KsTimeout

KsTimeout

@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class KsTimeout(val millis: Long = 0, val seconds: Long = 0, val minutes: Long = 0)

Sibling annotation for KsMethod that specifies a timeout for the remote call. The total timeout is computed as:

millis + seconds * 1000 + minutes * 60_000
Content copied to clipboard

When the total is positive, the generated stub wraps the call in withTimeout(totalMillis). If the call does not complete within the specified duration, a kotlinx.coroutines.TimeoutCancellationException is thrown and (on transports with cancellation support) the cancellation propagates to the server.

A total of 0 or negative means "no timeout" — the call proceeds without any timeout wrapper.

Properties

Link copied to clipboard
val millis: Long = 0
Link copied to clipboard
val minutes: Long = 0
Link copied to clipboard
val seconds: Long = 0
Generated by Dokka
© 2026 Copyright