javax.realtime.enforce

Class ResourceConstraint<T extends ResourceConstraint<T>>

java.lang.Object

javax.realtime.enforce.ResourceConstraint<T>

Type Parameters:

T -

Direct Known Subclasses:

BackingStoreConstraint, HeapConstraint, ImmortalConstraint, ProcessingConstraint, ThreadConstraint

public abstract class ResourceConstraint<T extends ResourceConstraint<T>>
extends java.lang.Object

The base class for all measurable constraints. There are several types of resource constraints typified by the value of <T> in the each concrete subclass. Each type is responsible for constraining on resource for a group of tasks (instances of Schedulable and other instances of java.lang.Thread). A task is only ever associated with one instance of a given type of ResourceConstraint via its RealtimeThreadGroup nearest instance, i.e., the first RealtimeThreadGroup found that has an associated instance of <T> when traversing up the thread group hierarchy from its immediate thread group.

Since:

RTSJ 2.0

Constructor Summary

Constructors

Constructor and Description
ResourceConstraint(RealtimeThreadGroup group) Create a new contraint with the given parent.

Method Summary

Modifier and Type	Method and Description
java.util.function.Consumer<T>	getNotificationHandler() Get the handler that should be called when this constraint is violated.
T	getParent()
RealtimeThreadGroup	getRealtimeThreadGroup() Determine the associated realtime thread group.
boolean	governs() See whether or not this task is governed, i.e., limited by this constraint.
boolean	governs(Schedulable schedulable) See whether or not schedulable is governed, i.e., limited by this constraint.
boolean	governs(java.lang.Thread thread) See whether or not thread is governed, i.e., limited by this constraint.
boolean	isEnforcing() Determine whether or not enforcing is in effect.
void	setNotificationHandler(java.util.function.Consumer<T> handler) Register a handler that should be called when this constraint is violated.
abstract void	start() Start applying this constraint to is tasks.
abstract void	stop() Stop applying this constraint to is tasks.
void	visitBorrowers(java.util.function.Consumer<T> visitor) Do something on each child constraint.
void	visitGoverned(java.util.function.Consumer<java.lang.Thread> visitor) Do something on each task subject to this constraint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceConstraint

public ResourceConstraint(RealtimeThreadGroup group)

Create a new contraint with the given parent.

Parameters:

group - The realtime thread group this constraint should govern.

Method Detail

getParent

public T getParent()

isEnforcing

public boolean isEnforcing()

Determine whether or not enforcing is in effect.

Returns:

true when yes and false when not.

start

public abstract void start()

Start applying this constraint to is tasks.

stop

public abstract void stop()

Stop applying this constraint to is tasks.

getRealtimeThreadGroup

public RealtimeThreadGroup getRealtimeThreadGroup()

Determine the associated realtime thread group.

Returns:

the associated group

governs

public boolean governs()

See whether or not this task is governed, i.e., limited by this constraint.

Returns:

true when the current task in governed by this constraint; otherwise false.

governs

public boolean governs(java.lang.Thread thread)

See whether or not thread is governed, i.e., limited by this constraint.

Parameters:

thread - The thread in question

Returns:

true when the current task in governed by this constraint; otherwise false.

governs

public boolean governs(Schedulable schedulable)

See whether or not schedulable is governed, i.e., limited by this constraint.

Parameters:

schedulable - The schedulable in question

Returns:

true when the current task in governed by this constraint; otherwise false.

visitGoverned

public final void visitGoverned(java.util.function.Consumer<java.lang.Thread> visitor)

Do something on each task subject to this constraint.

Parameters:

visitor - the code to execute on each task.

visitBorrowers

public final void visitBorrowers(java.util.function.Consumer<T> visitor)

Do something on each child constraint.

Parameters:

visitor - the code to execute on each child.

setNotificationHandler

public void setNotificationHandler(java.util.function.Consumer<T> handler)

Register a handler that should be called when this constraint is violated.

Parameters:

handler - A consumer that accepts the constraint object. Thread.currentThread() can be used to identify the thread that caused the overrun.

getNotificationHandler

public java.util.function.Consumer<T> getNotificationHandler()

Get the handler that should be called when this constraint is violated.

Returns:

the registered handler.