terminalBusy: Is Terminal Busy
In rstudioapi: Safely Access the RStudio API

terminalBusy

R Documentation

Is Terminal Busy

Description

Are terminals reporting that they are busy?

Usage

terminalBusy(id)

Arguments

`id`	The terminal id. The `id` is obtained from `terminalList()`, `terminalVisible()`, `terminalCreate()`, or `terminalExecute()`.

Details

This feature is only supported on RStudio Desktop for Mac and Linux, and RStudio Server. It always returns FALSE on RStudio Desktop for Microsoft Windows.

Value

a boolean

Note

The terminalBusy function was added in version 1.1.350 of RStudio.

Examples


## Not run: 
# create a hidden terminal and run a lengthy command
termId <- rstudioapi::terminalCreate(show = FALSE)
rstudioapi::terminalSend(termId, "sleep 5\n")

# wait until a busy terminal is finished
while (rstudioapi::terminalBusy(termId)) {
  Sys.sleep(0.1)
}
print("Terminal available")

## End(Not run)

rstudioapi documentation built on Oct. 23, 2024, 1:07 a.m.