IJobSchedulerContextReserveResource Method (String, Int64, Boolean, Int32)

Reserves the resource with the specified amount, possibly restricting to children jobs, and with the specified time-out.
Namespace:  AGI.Parallel.Infrastructure
Assembly:  AGI.Parallel.Infrastructure (in AGI.Parallel.Infrastructure.dll) Version: 1.4.0.476 (1.4.0.476)
Syntax
long ReserveResource(
        string resource,
        long amount,
        bool restrictToChildren,
        int millisecondsTimeout
)

Parameters

resource
Type: SystemString
The resource. You can find common values for resources using ConsumableResources.
amount
Type: SystemInt64
The amount.
restrictToChildren
Type: SystemBoolean
if set to true will reserve resources only from child jobs.
millisecondsTimeout
Type: SystemInt32
The number of milliseconds to wait, or System.Threading.Timeout.Infinite (-1) to wait indefinitely.

Return Value

Type: Int64
The resource amount currently consumed by the task.
Exceptions
Exception Condition
ArgumentNullException If resource is null.
ArgumentOutOfRangeException If amount if less than 0.
JobSchedulerException If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.
Remarks
Blocks until the resource becomes available or the time-out expires. If the time-out expires a JobSchedulerException is thrown.
See Also

STK Scalability 1.4 API for .NET