dsIsCompleted: Get whether the operation is completed

In DSI: 'DataSHIELD' Interface

Get whether the operation is completed

Description

Get whether the result from a previous assignment or aggregation operation was completed, either with a successful status or a failed one. This call must not wait for the completion, immediate response is expected. Once the result is identified as being completed, the raw result the operation can be get directly.

\Sexpr[results=rd,stage=render]{DSI:::methods_as_rd("dsIsCompleted")}

Usage

dsIsCompleted(res)

Arguments

res	An object inheriting from DSResult-class.

Value

A logical

See Also

Other DSResult generics: DSResult-class, dsFetch(), dsGetInfo()

Examples

## Not run: 
con <- dsConnect(DSOpal::Opal(), "server1",
  username = "dsuser", password = "password", url = "https://opal-demo.obiba.org")
dsAssignExpr(con, "C", as.symbol("c(1, 2, 3)"))
res <- dsAggregate(con, as.symbol("length(C)"), async = TRUE)
completed <- dsIsCompleted(res)
while (!completed) {
  Sys.sleep(1)
  completed <- dsIsCompleted(res)
}
length <- dsFetch(res)
dsDisconnect(con)

## End(Not run)

DSI documentation built on Oct. 6, 2022, 9:06 a.m.