Job Class

Represents a group of tasks in the system.

Inheritance Hierarchy

SystemObject
AGI.Parallel.ClientJob

Namespace: AGI.Parallel.Client
Assembly: AGI.Parallel.Client (in AGI.Parallel.Client.dll) Version: 2.10.0.1777 (2.10.0.1777)

Syntax

Copy

public class Job : IJob

Public Class Job
	Implements IJob

The Job type exposes the following members.

Constructors

	Name	Description
	Job	Initializes a new instance of the Job class.

Top

Properties

	Name	Description
	AdditionalDependencies	Gets the additional dependency that are sent with the Job.
	AgentSelectionPreference	Gets or sets the agent selection preference.
	CancelOnClientDisconnection	Gets or sets a value indicating whether to cancel the tasks of this Job when the client disconnects.
	CancelOnTaskFailure	Gets or sets a value indicating whether to cancel other tasks on this Job if another Task fails.
	Description	Gets or sets the Job description.
	ExcludedDependencies	Gets the excluded assemblies that are not sent with the Job.
	ExclusiveExecution	Gets or sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
	FailIfPreconditionsNotSatisfied	Gets or sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
	Id	Gets the job's id.
	IsCanceled	Gets a value indicating whether this job has been canceled.
	MaxTaskInterruptedRetryAttempts	Gets or sets the maximum number of times a task will be retried if it is interrupted.
	MinimizeClientMessaging	Gets or sets a value indicating whether to minimize sending some messages from the Coordinator. If set to true, some events may not fire.
	Name	Gets or sets the Job name.
	Priority	Gets or sets the job priority.
	RaiseEventsUsingSynchronizationContext	Gets or sets a value indicating whether Job and Task events such as JobCompleted are raised using the SynchronizationContext of the thread that submits the job. If this property is , no events are raised until WaitUntilDone is called, at which point the events are raised in the thread that calls it. If this property is , events are raised by posting them to the SynchronizationContext of the thread that calls Submit, no matter if WaitUntilDone is called or not.
	TaskEnvironment	Gets or sets Job's TaskEnvironment
	TaskExecutionTimeout	Gets or sets the timeout for task execution in milliseconds.
	TaskPreconditions	Gets the list of task pre conditions.
	Tasks	Gets the tasks that are contained in this Job.

Top

Methods

	Name	Description
	AddTask	Adds a task to Job.
	Cancel	Cancels all tasks in this job. Will not listen for cancellation events.
	Cancel(Boolean)	Cancels all tasks in this job.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Submit	Submits job to job scheduler.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WaitUntilDone	Blocks until all tasks in this job complete.
	WaitUntilDone(Int32)	Blocks until all tasks in this job complete or the operation times out.
	WaitUntilDone(Int32, Action, Int32)	Blocks until all tasks in this job complete or the operation times out. The callback passed in for the heartbeat is called with the period specified by the millisecondsHeartbeat argument.

Top

Events

	Name	Description
	JobCompleted	Occurs when all tasks of a Job is completed.
	JobSubmitted	Occurs when Job is submitted.
	TaskCompleted	Occurs when Task is completed.
	TaskProgressUpdated	Occurs when Task progress changes.
	TaskStateChanged	Occurs when Task status changes.

Top

Examples

Copy

using (IJobScheduler scheduler = new ClusterJobScheduler("localhost"))
{
    scheduler.Connect();

    // Create job using IJobScheduler.CreateJob
    Job job = scheduler.CreateJob();

    // Add one or more tasks
    job.AddTask(new SimpleTask(1, 1));

    // Set the task environment
    job.TaskEnvironment = new MyEnvironment();

    // Set the various job options
    job.Name = "My job name";
    job.Description = "My job description";
    job.MaxTaskInterruptedRetryAttempts = 0;
    job.Priority = JobPriority.Low;
    job.TaskPreconditions.Add(CommonResources.AvailableCores, Operator.GreaterThan, 2);

    // Submit task to job scheduler
    job.Submit();

    // Wait for the results
    job.WaitUntilDone();
}

Reference

AGI.Parallel.Client Namespace

Other Resources

Key concepts

Tutorial