Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

function libtmux-kotlin latest

await

Package io.github.libtmux.Channel.await io.github.libtmux.Channel

Waits for something to signal this channel.

View as Markdown

Source and package
Module
io.github.libtmux.Channel
Package
io.github.libtmux:libtmux-kotlin
Source
libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Waits.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 Channel.await( timeout: Duration, dispatcher: CoroutineDispatcher = Dispatchers.IO, ): WakeReason
functionasync [source]

Description#

Cancelling the coroutine interrupts the wait. That is not a timeout. A wait-for tmux has already accepted is not taken back.

Parameters
Returns

why the wait ended

Esc

Type to search.