okio/okio/ForwardingTimeout

ForwardingTimeout

open class ForwardingTimeout(var delegate: Timeout) : Timeout

A Timeout which forwards calls to another. Useful for subclassing.

Constructors

ForwardingTimeout

constructor(delegate: Timeout)

Properties

delegate

@get:JvmName(name = "delegate")

var delegate: Timeout

Functions

awaitSignal

open override fun awaitSignal(condition: Condition)

Waits on monitor until it is signaled. Throws InterruptedIOException if either the thread is interrupted or if this timeout elapses before monitor is signaled. The caller must hold the lock that monitor is bound to.

cancel

open override fun cancel()

Prevent all current applications of this timeout from firing. Use this when a time-limited operation should no longer be time-limited because the nature of the operation has changed.

clearDeadline

open override fun clearDeadline(): Timeout

Clears the deadline.

clearTimeout

open override fun clearTimeout(): Timeout

Clears the timeout. Operating system timeouts may still apply.

deadline

fun deadline(duration: Long, unit: TimeUnit): Timeout

Set a deadline of now plus duration time.

deadlineNanoTime

open override fun deadlineNanoTime(): Long

Returns the nano time when the deadline will be reached.

open override fun deadlineNanoTime(deadlineNanoTime: Long): Timeout

Sets the nano time when the deadline will be reached. All operations must complete before this time. Use a deadline to set a maximum bound on the time spent on a sequence of operations.

hasDeadline

open override fun hasDeadline(): Boolean

Returns true if a deadline is enabled.

intersectWith

inline fun <T> intersectWith(other: Timeout, block: () -> T): T

Applies the minimum intersection between this timeout and other, run block, then finally rollback this timeout's values.

setDelegate

fun setDelegate(delegate: Timeout): ForwardingTimeout

throwIfReached

open override fun throwIfReached()

Throws an InterruptedIOException if the deadline has been reached or if the current thread has been interrupted. This method doesn't detect timeouts; that should be implemented to asynchronously abort an in-progress operation.

timeout

open override fun timeout(timeout: Long, unit: TimeUnit): Timeout

Wait at most timeout time before aborting an operation. Using a per-operation timeout means that as long as forward progress is being made, no sequence of operations will fail.

timeout

fun Timeout.timeout(duration: Duration): Timeout

fun Timeout.timeout(timeout: Long, unit: DurationUnit): Timeout

timeoutNanos

open override fun timeoutNanos(): Long

Returns the timeout in nanoseconds, or 0 for no timeout.

waitUntilNotified

open override fun waitUntilNotified(monitor: Any)

Waits on monitor until it is notified. Throws InterruptedIOException if either the thread is interrupted or if this timeout elapses before monitor is notified. The caller must be synchronized on monitor.