WorkerJob class

A class that represents a job to be done by a ProcessPool.

Create a list of these to pass to ProcessPool.startWorkers or ProcessPool.runToCompletion.

Inheritance

Constructors

WorkerJob(List<String> command, {String? name, Directory? workingDirectory, bool printOutput = false, Stream<String>? stdin, Stream<List<int>>? stdinRaw, bool failOk = true, bool runInShell = false, Iterable<DependentJob>? dependsOn})

Properties

command List<String>
The name and arguments for the process, including the command name as command0.
final
dependsOn Set<DependentJob>
Other jobs that this job depends on.
no setterinherited
exception Exception?
Once the job is complete, if it had an exception while running, this member contains the exception.
getter/setter pair
failOk bool
Whether or not failure of this job should throw an exception.
final
hashCode int
The hash code for this object.
no setterinherited
name String
The name of the job.
final
printOutput bool
Whether or not this command should print it's stdout when it runs.
final
result ProcessRunnerResult
Once the job is complete, this contains the result of the job.
getter/setter pair
runInShell bool
If set to true, the process will run be spawned through a system shell.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stdin Stream<String>?
If set, the stream to read the stdin for this process from.
final
stdinRaw Stream<List<int>>?
If set, the stream to read the raw stdin for this process from.
final
workingDirectory Directory?
The working directory that the command should be executed in.
final

Methods

addDependencies(Iterable<DependentJob> jobs) → void
Adds all of the jobs as dependencies of this job.
inherited
addDependency(DependentJob job) → void
Add a dependency to this job.
inherited
addToQueue(List<DependentJob> jobQueue) → void
Adds this job, and any jobs it manages to the given jobQueue.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeDependencies(Iterable<DependentJob> jobs) → void
Removes all of the given jobs as dependencies of this job.
inherited
removeDependency(DependentJob job) → void
Remove a dependency to this job that was added with addDependency.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited