javax.realtime
Interface Schedulable

All Superinterfaces:

Runnable

All Known Subinterfaces:

Executor

All Known Implementing Classes:

AsyncEventHandler, PooledExecutor, RealtimeThread, ThreadBoundExecutor, ThreadedExecutor

public interface Schedulable

extends Runnable

Handlers and other objects can be run by a Scheduler if they provide a run() method and the methods defined below. The Scheduler uses this information to create a suitable context to execute the run() method.

Author:

Angelo Corsaro

Method Summary

boolean	addIfFeasible() Add to the feasibility of the associated scheduler if the resulting feasibility is schedulable.
boolean	addToFeasibility() Inform the scheduler and cooperating facilities that the resource demands (as expressed in the associated instances of SchedulingParameters, ReleaseParameters, MemoryParameters, and ProcessingGroupParameters) of this instance of Schedulable will be considered in the feasibility analysis of the associated Scheduler until further notice.
int	executionEligibility() NOTE: This method is not part of the RTSJ Specification.
MemoryParameters	getMemoryParameters() Get the MemoryParameters of this schedulable object.
ProcessingGroupParameters	getProcessingGroupParameters() Get the ProcessingGroupParameters of this schedulable object.
ReleaseParameters	getReleaseParameters() Get the ReleaseParameters of this schedulable object.
Scheduler	getScheduler() Get the Scheduler for this schedulable object.
SchedulingParameters	getSchedulingParameters() Get the SchedulingParameters for this schedulable object.
boolean	removeFromFeasibility() Inform the scheduler and cooperating facilities that the resource demands, as expressed in the associated instances of SchedulingParameters, ReleaseParameters, MemoryParameters, and ProcessingGroupParameters, of this instance of Schedulable should no longer be considered in the feasibility analysis of the associated Scheduler.
void	setMemoryParameters(MemoryParameters memoryParam) Set the MemoryParameters for this schedulable object.
boolean	setMemoryParametersIfFeasible(MemoryParameters memoryParam) Set the MemoryParameters for this schedulable object.
void	setProcessingGroupParameters(ProcessingGroupParameters groupParam) Set the ProcessingGroupParameters for this schedulable object.
boolean	setProcessingGroupParametersIfFeasible(ProcessingGroupParameters groupParam) Set the ProcessingGroupParameters of this schedulable object only if the resulting task set is feasible.
void	setReleaseParameters(ReleaseParameters releaseParam) Set the ReleaseParameters for this schedulable object.
boolean	setReleaseParametersIfFeasible(ReleaseParameters releaseParam) Set the ReleaseParameters for this schedulable object only if the resulting task set is feasible.
void	setScheduler(Scheduler scheduler) Set the Scheduler for this schedulable object.
void	setScheduler(Scheduler scheduler, SchedulingParameters schedParam, ReleaseParameters releaseParam, MemoryParameters memoryParam, ProcessingGroupParameters groupParam) Set the Scheduler for this schedulable object.
void	setSchedulingParameters(SchedulingParameters schedParam) Set the SchedulingParameters for this schedulable object only if the resulting task set is feasible.
boolean	setSchedulingParametersIfFeasible(SchedulingParameters schedParam) Set the SchedulingParameters for this schedulable object.

Methods inherited from interface java.lang.Runnable

run

Method Detail

addIfFeasible

public boolean addIfFeasible()

Add to the feasibility of the associated scheduler if the resulting feasibility is schedulable. If successful return true, if not return false. If there is not assigned scheduler false is returned.

Returns:

true if the resulting scheduler is feasible.

addToFeasibility

public boolean addToFeasibility()

Inform the scheduler and cooperating facilities that the resource demands (as expressed in the associated instances of SchedulingParameters, ReleaseParameters, MemoryParameters, and ProcessingGroupParameters) of this instance of Schedulable will be considered in the feasibility analysis of the associated Scheduler until further notice. Whether the resulting system is feasible or not, the addition is completed.

Returns:

true If the resulting system is feasible.

getMemoryParameters

public MemoryParameters getMemoryParameters()

Get the MemoryParameters of this schedulable object.

Returns:

a MemoryParameters value.

setMemoryParameters

public void setMemoryParameters(MemoryParameters memoryParam)

Set the MemoryParameters for this schedulable object.

Parameters:

memoryParam - the MemoryParameters for this schedulable object.

setMemoryParametersIfFeasible

public boolean setMemoryParametersIfFeasible(MemoryParameters memoryParam)

Set the MemoryParameters for this schedulable object.

Parameters:

memoryParam - the MemoryParameters for this schedulable object.

Returns:

true if the requested change keeps the system feasible.

getProcessingGroupParameters

public ProcessingGroupParameters getProcessingGroupParameters()

Get the ProcessingGroupParameters of this schedulable object.

Returns:

a ProcessingGroupParameters value

setProcessingGroupParameters

public void setProcessingGroupParameters(ProcessingGroupParameters groupParam)

Set the ProcessingGroupParameters for this schedulable object.

Parameters:

groupParam - a ProcessingGroupParameters value

setProcessingGroupParametersIfFeasible

public boolean setProcessingGroupParametersIfFeasible(ProcessingGroupParameters groupParam)

Set the ProcessingGroupParameters of this schedulable object only if the resulting task set is feasible.

Parameters:

groupParam - a ProcessingGroupParameters value

Returns:

Returns true if, after considering the values of the parameters, the task set would still be feasible. In this case the values of the parameters are changed. Returns false if, after considering the values of the parameters, the task set would not be feasible. In this case the values of the parameters are not changed.

getReleaseParameters

public ReleaseParameters getReleaseParameters()

Get the ReleaseParameters of this schedulable object.

Returns:

a ReleaseParameters value

setReleaseParameters

public void setReleaseParameters(ReleaseParameters releaseParam)

Set the ReleaseParameters for this schedulable object.

Parameters:

releaseParam - a ReleaseParameters value

setReleaseParametersIfFeasible

public boolean setReleaseParametersIfFeasible(ReleaseParameters releaseParam)

Set the ReleaseParameters for this schedulable object only if the resulting task set is feasible.

Parameters:

releaseParam - a ReleaseParameters value

getScheduler

public Scheduler getScheduler()

Get the Scheduler for this schedulable object.

Returns:

a Scheduler value

setScheduler

public void setScheduler(Scheduler scheduler)
                  throws IllegalThreadStateException

Set the Scheduler for this schedulable object.

Parameters:

scheduler - the scheduler.

Throws:

IllegalThreadStateException

setScheduler

public void setScheduler(Scheduler scheduler,
                         SchedulingParameters schedParam,
                         ReleaseParameters releaseParam,
                         MemoryParameters memoryParam,
                         ProcessingGroupParameters groupParam)
                  throws IllegalThreadStateException

Set the Scheduler for this schedulable object.

Parameters:

scheduler - a Scheduler value

schedParam - a SchedulingParameters value

releaseParam - a ReleaseParameters value

memoryParam - a MemoryParameters value

groupParam - a ProcessingGroupParameters value

Throws:

IllegalThreadStateException - if an error occurs

getSchedulingParameters

public SchedulingParameters getSchedulingParameters()

Get the SchedulingParameters for this schedulable object.

Returns:

a SchedulingParameters value

setSchedulingParameters

public void setSchedulingParameters(SchedulingParameters schedParam)

Set the SchedulingParameters for this schedulable object only if the resulting task set is feasible.

Parameters:

schedParam - a SchedulingParameters value

setSchedulingParametersIfFeasible

public boolean setSchedulingParametersIfFeasible(SchedulingParameters schedParam)

Set the SchedulingParameters for this schedulable object.

Parameters:

schedParam - a SchedulingParameters value

Returns:

true if the change was feasible, false otherwise.

removeFromFeasibility

public boolean removeFromFeasibility()

Inform the scheduler and cooperating facilities that the resource demands, as expressed in the associated instances of SchedulingParameters, ReleaseParameters, MemoryParameters, and ProcessingGroupParameters, of this instance of Schedulable should no longer be considered in the feasibility analysis of the associated Scheduler. Whether the resulting system is feasible or not, the subtrac-tion is completed.

Returns:

true If the resulting system is feasible.

executionEligibility

public int executionEligibility()

NOTE: This method is not part of the RTSJ Specification. It is used internally by this RTSJ implementation.

Returns:

an int value used internally to represent a total ordering of the schedulable entities.