JobWaitUntilDone Method (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.

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

Syntax

Copy

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

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

Parameters

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

IJobWaitUntilDone(Int32, Action, Int32)

Exceptions

Exception	Condition
JobSchedulerException	If error occurs with job scheduler such as the client timing out.

Reference

Job Class

WaitUntilDone Overload

AGI.Parallel.Client Namespace

JobAddLanguageSpecificTextSet("LST7434CCAB_0?cpp=::|nu=.");WaitUntilDone Method (Int32, Action, Int32)

Parameters

Return Value

Implements

Reference

JobWaitUntilDone Method (Int32, Action, Int32)