IJobScheduler.WaitUntilDone Method

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.

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

Syntax

Copy

bool WaitUntilDone(
	Guid jobId,
	int millisecondsTimeout,
	Action heartbeatCallback,
	int millisecondsHeartbeat
)

Function WaitUntilDone ( 
	jobId As Guid,
	millisecondsTimeout As Integer,
	heartbeatCallback As Action,
	millisecondsHeartbeat As Integer
) As Boolean

Parameters

jobId: Type: System.Guid
The job id for the job to be submitted.
millisecondsTimeout: Type: System.Int32
The timeout (in milliseconds).
heartbeatCallback: Type: System.Action
The heartbeat callback.
millisecondsHeartbeat: Type: System.Int32
The heartbeat period (in milliseconds).

Return Value

Type: Boolean
true if job completed, false if timed-out.

Exceptions

Exception	Condition
JobSchedulerException	Thrown if client disconnects from the job scheduler.

Reference

IJobScheduler Interface

AGI.Parallel.Client Namespace

IJobScheduler.AddLanguageSpecificTextSet("LSTBF0FF00_0?cpp=::|nu=.");WaitUntilDone Method

Parameters

Return Value

Reference

IJobScheduler.WaitUntilDone Method