From daae53de09d3abb0c9daa88c2455078e3ab97a47 Mon Sep 17 00:00:00 2001 From: Paolo Di Tommaso Date: Sun, 1 Dec 2024 10:53:01 +0100 Subject: [PATCH] Improve job manager docs [ci skip] Signed-off-by: Paolo Di Tommaso --- .../io/seqera/wave/service/job/JobManager.groovy | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy b/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy index 3b6f7cce2..16a3c52e7 100644 --- a/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy +++ b/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy @@ -73,6 +73,16 @@ class JobManager { queue.addConsumer((job)-> processJob(job)) } + /** + * Process a job entry aorrding the state modelled by the {@link JobSpec} object. + * + * @param jobSpec + * A {@link JobSpec} object representing the job to be processed + * @return + * {@code true} to signal the process has been processed successfully and it should + * be removed from the underlying queue, or {@code false} if the job execution has + * not yet completed. + */ protected boolean processJob(JobSpec jobSpec) { try { return processJob0(jobSpec)