agi.parallel.infrastructure

Interface IJobSchedulerContext

All Superinterfaces:

IMessageEndpoint

public interface IJobSchedulerContext
extends IMessageEndpoint

Allows interaction with the job scheduler.

Method Summary

Modifier and Type	Method and Description
IJob	createChildJob() Creates a child job and yields all resources to children.
IJob	createChildJob(boolean yieldAllResourcesToChildren) Creates a child job.
long	reserveResource(java.lang.String resource, long amount) Reserves the resource with the specified amount.
long	reserveResource(java.lang.String resource, long amount, boolean restrictToChildren) Reserves the resource with the specified amount, possibly restricting to children jobs.
long	reserveResource(java.lang.String resource, long amount, boolean restrictToChildren, int millisecondsTimeout) Reserves the resource with the specified amount, possibly restricting to children jobs, and with the specified time-out.
long	reserveResource(java.lang.String resource, long amount, int millisecondsTimeout) Reserves the resource with the specified amount, with the specified time-out.
long	yieldResource(java.lang.String resource, long amount) Yields the resource with the specified amount without a restriction to children.
long	yieldResource(java.lang.String resource, long amount, boolean restrictToChildren) Yields the resource with the specified amount.

Methods inherited from interface agi.parallel.infrastructure.IMessageEndpoint

addNewMessageListener, getId, postMessage, postMessage, receiveMessage, receiveMessage, receiveMessage, receiveMessage

Method Detail

createChildJob

IJob createChildJob()

Creates a child job and yields all resources to children.

Returns:

Job which can be submitted back to same job scheduler that the current task was submitted to.

createChildJob

IJob createChildJob(boolean yieldAllResourcesToChildren)

Creates a child job.

Parameters:

yieldAllResourcesToChildren - If set to true yields all resources to children once the job is submitted.

Returns:

Job which can be submitted back to same job scheduler that the current task was submitted to.

reserveResource

long reserveResource(java.lang.String resource,
                     long amount)

Reserves the resource with the specified amount.

Blocks until the resource becomes available.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.

reserveResource

long reserveResource(java.lang.String resource,
                     long amount,
                     boolean restrictToChildren)

Reserves the resource with the specified amount, possibly restricting to children jobs.

Blocks until the resource becomes available.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

restrictToChildren - If set to true will reserve resources only from child jobs.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.

reserveResource

long reserveResource(java.lang.String resource,
                     long amount,
                     int millisecondsTimeout)

Reserves the resource with the specified amount, with the specified time-out.

Blocks until the resource becomes available or the time-out expires. If the time-out expires a JobSchedulerException is thrown.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

millisecondsTimeout - The number of milliseconds to wait, or -1 to wait indefinitely.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.

reserveResource

long reserveResource(java.lang.String resource,
                     long amount,
                     boolean restrictToChildren,
                     int millisecondsTimeout)

Reserves the resource with the specified amount, possibly restricting to children jobs, and with the specified time-out.

Blocks until the resource becomes available or the time-out expires. If the time-out expires a JobSchedulerException is thrown.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

restrictToChildren - If set to true will reserve resources only from child jobs.

millisecondsTimeout - The number of milliseconds to wait, or -1 to wait indefinitely.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.

yieldResource

long yieldResource(java.lang.String resource,
                   long amount)

Yields the resource with the specified amount without a restriction to children.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, there were not enough resources to satisfy reserve request.

yieldResource

long yieldResource(java.lang.String resource,
                   long amount,
                   boolean restrictToChildren)

Yields the resource with the specified amount.

Parameters:

resource - The resource. You can find common values for resources using ConsumableResources.

amount - The amount.

restrictToChildren - If set to true will yield resources only to child jobs.

Returns:

The resource amount currently consumed by the task.

Throws:

java.lang.IllegalArgumentException - If resource is null.

java.lang.IllegalArgumentException - If amount if less than 0.

JobSchedulerException - If error occurred during operation. For instance, yield amount was more than the amount current allocated.