diff options
| author | Ricardo Wurmus <rekado@elephly.net> | 2021-02-16 17:25:39 +0100 |
|---|---|---|
| committer | Ricardo Wurmus <rekado@elephly.net> | 2021-02-16 17:25:39 +0100 |
| commit | 771637559a1c0440757ad78c62ea9e736ec6a8ba (patch) | |
| tree | 8fbd82f2d9a448f61948daae573083cb5043384e /drmaa | |
| parent | 361de9733924c796cfb09a9fd300b5cd7c4a893d (diff) | |
low: wait: Add docstring, make TIMEOUT argument optional.
Diffstat (limited to 'drmaa')
| -rw-r--r-- | drmaa/v1/low.scm | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/drmaa/v1/low.scm b/drmaa/v1/low.scm index 624c018..3003052 100644 --- a/drmaa/v1/low.scm +++ b/drmaa/v1/low.scm @@ -476,7 +476,17 @@ the current session will be affected." (DRMAA 'ERROR_STRING_BUFFER)) #true error-message))) -(define (wait job-id timeout) +(define* (wait job-id #:optional timeout) + "Wait for the completion of a job with identifier JOB-ID. If the +JOB-ID is the special symbol '*, wait for the completion of any job +that has been submitted during this session. + +TIMEOUT (an integer) specifies the number of seconds to block. If it +is not provided or is #FALSE this procedure will block forever. + +This procedure returns three values: the identifier of the job that +has completed, the status code of the job (an opaque value), and an +alist of resource usage statistics." (let ((timeout (or timeout (DRMAA 'TIMEOUT_WAIT_FOREVER))) (job-id-out |