EmbeddedJobSchedulerWaitUntilDone 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.EmbeddedClient (in AGI.Parallel.EmbeddedClient.dll) Version: 2.9.0.1601 (2.9.0.1601)

Syntax

Copy

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

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

Parameters

jobId: Type: SystemGuid
The job id for the job to be submitted.
millisecondsTimeout: Type: SystemInt32
The timeout (in milliseconds).
heartbeatCallback: Type: SystemAction
The heartbeat callback.
millisecondsHeartbeat: Type: SystemInt32
The heartbeat period (in milliseconds).

Return Value

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

Implements

IJobSchedulerWaitUntilDone(Guid, Int32, Action, Int32)

Exceptions

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

Reference

EmbeddedJobScheduler Class

AGI.Parallel.Client Namespace

EmbeddedJobSchedulerAddLanguageSpecificTextSet("LST422903FE_0?cpp=::|nu=.");WaitUntilDone Method

Parameters

Return Value

Implements

Reference

EmbeddedJobSchedulerWaitUntilDone Method