API Reference

Job(core::Thunk; description="", username="")

Create a simple job.

Arguments

• core: a Thunk that encloses the job core definition.
• name: give a short name to the job.
• description::String="": describe what the job does in more detail.
• username::String="": indicate who executes the job.

Examples

julia> using Thinkers

julia> a = Job(Thunk(sleep, 5); username="me", description="Sleep for 5 seconds");

julia> b = Job(Thunk(run, `pwd` & `ls`); username="me", description="Run some commands");

chain!(x::AbstractJob, y::AbstractJob, z::AbstractJob...)

Chain multiple AbstractJobs one after another.

→(x, y)

Chain two AbstractJobs.

←(y, x)

Chain two AbstractJobs reversely.

run!(job::Job; maxattempts=1, interval=1, delay=0, wait=false)
run!(job::Job, worker::Integer; maxattempts=1, interval=1, delay=0, wait=false)

Run a Job with a maximum number of attempts, with each attempt separated by interval seconds and an initial delay in seconds.

execute!(job::AbstractJob, exec::Executor)

Execute a given AbstractJob associated with the Executor.

This function checks if the job has succeeded. If so, it stops immediately. If not, it sleeps for a exec.delay, then runs the job. If exec.maxattempts is more than $1$, it loops over the remaining attempts, sleeping for an exec.interval, running the job, and waiting in each loop.

getstatus(job::AbstractJob)

Get the current status of the job.

ispending(job::AbstractJob)

Test if the job is still pending.

isrunning(job::AbstractJob)

Test if the job is running.

isexited(job::AbstractJob)

Test if the job has exited.

issucceeded(job::AbstractJob)

Test if the job was successfully run.

isfailed(job::AbstractJob)

Test if the job failed during running.

listpending(jobs)

Filter the pending jobs in a sequence of jobs.

listrunning(jobs)

Filter the running jobs in a sequence of jobs.

listexited(jobs)

Filter the exited jobs in a sequence of jobs.

listsucceeded(jobs)

Filter the succeeded jobs in a sequence of jobs.

listfailed(jobs)

Filter the failed jobs in a sequence of jobs.

countexecution(job::AbstractJob)

Count how many times the job has been run.

descriptionof(job::AbstractJob)

Return the description of the job.

creationtimeof(job::AbstractJob)

Return the creation time of the job.

starttimeof(job::AbstractJob)

Return the start time of the job. Return nothing if it is still pending.

endtimeof(job::AbstractJob)

Return the end time of the job. Return nothing if it has not exited.

timecostof(job::AbstractJob)

Return the time cost of the job since it started running.

If nothing, the job is still pending. If it is finished, return how long it took to complete.

getresult(job::AbstractJob)

Get the running result of the job.

The result is wrapped by a Some type. Use something to retrieve its value. If it is nothing, the job is not finished.

countparents(job::AbstractJob)

Count the number of parent jobs for a given job.

countchildren(job::AbstractJob)

Count the number of child jobs for a given job.

AsyncExecutor(; maxattempts=1, interval=1, delay=0, wait=false)

Handle the asynchronous execution of jobs.

Arguments

• maxattempts::UInt64=1: the maximum number of attempts to execute the job.
• interval::Real=1: the time interval between each attempt to execute the job, in seconds.
• delay::Real=0: the delay before the first attempt to execute the job, in seconds.
• wait::Bool=false: determines whether to wait for the job to complete before executing the next task.