method libtmux-kotlin latest
Pane.await
Waits until settled accepts this pane, read fresh from tmux before each test.
Source and package
- Module
- io.github.libtmux.kotlin
- Declared in
- Pane
- Package
- io.github.libtmux:libtmux-kotlin
- Source
- libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Pane.kt
- public Kotlin suspending functions Allows a function to call suspending operations and pause without blocking a thread. It does not start a coroutine by itself. Language documentation fun await( timeout: Duration, every: Duration = 50.milliseconds, dispatcher: Coroutine
Dispatcher = Dispatchers.IO , settled: (Pane) -> Boolean, ): WakeReason -
Description#
Cancelling the coroutine interrupts the wait. That is not a timeout. A read already sent to tmux is not taken back.
- Parameters
-
-
timeout ( Duration ) – how long to keep looking, finite and not negative
-
every ( Duration ) – how long to leave between looks, at least 10 ms
-
dispatcher ( Coroutine
Dispatcher ) – where the blocking wait runs
-
- Returns
-
why the wait ended