Package javax.realtime

This package encapsulates the core RTSJ module.

See: Description

Interface Summary

Interface	Description
ActiveEvent<T extends Releasable<T,D>,D extends ActiveEventDispatcher<D,T>>	This is the interface for defining the active event system.
BoundSchedulable	A marker interface to provide a type safe reference to all schedulables that are bound to a single underlying thread.
Chronograph	The interface for all devices that support the measurement of time with great accuracy.
Interruptible	Deprecated in RTSJ 2.0; moved to package javax.realtime.control
PhysicalMemoryTypeFilter	Deprecated as of RTSJ 2.0
Releasable<T extends Releasable<T,D>,D extends ActiveEventDispatcher<D,T>>	A base interface for everything that can be dispatched and hence has a asynchronous release cycle.
ReleaseRunner.Proxy	An interface to encapsulate the execution contexts for running an instance of AsyncBaseEventHandler.
Schedulable	An interface for all types of task defined in this specification.
StaticThrowable<T extends StaticThrowable<T>>	A marker interface to indicate that a Throwable is intended to be created once and reused.
Subsumable<T>	A partial ordering relationship.

Class Summary

Class	Description
AbsoluteTime	An object that represents a specific point in time given by milliseconds plus nanoseconds past some point in time fixed by its Chronograph.
ActiveEventDispatcher<D extends ActiveEventDispatcher<D,T>,T extends Releasable<T,D>>	Provides a means of dispatching a set of Releasable instances.
Affinity	This is class for specifying processor affinity.
AperiodicParameters	When a reference to an AperiodicParameters object is given as a parameter to a schedulable's constructor or passed as an argument to one of the schedulable's setter methods, the AperiodicParameters object becomes the release parameters object bound to that schedulable.
AsyncBaseEvent	This is the base class for all asynchronous events, where asynchronous is in regards to running code, not external time.
AsyncBaseEventHandler	This is the base class for all asynchronous event handlers, where asynchronous is in regards to running code, not external time.
AsyncEvent	An asynchronous event can have a set of handlers associated with it, and when the event occurs, the fireCount of each handler is incremented, and the handlers are released (see AsyncEventHandler).
AsyncEventHandler	An asynchronous event handler encapsulates code that is released after an instance of AsyncEvent to which it is attached occurs.
AsyncLongEvent	A new type of event that carries a long as a payload.
AsyncLongEventHandler	A version of AsyncBaseEventHandler that carries a long value as payload.
AsyncObjectEvent<P>	A new type of event that carries an object as a payload.
AsyncObjectEventHandler<P>	A version of AsyncBaseEventHandler that carries an Object value as payload.
BackgroundParameters	Parameters for realtime threads that are only released once.
BoundAsyncEventHandler	A bound asynchronous event handler is an instance of AsyncEventHandler that is permanently bound to a dedicated realtime thread.
BoundAsyncLongEventHandler	A bound asynchronous event handler is an instance of AsyncLongEventHandler that is permanently bound to a dedicated RealtimeThread.
BoundAsyncObjectEventHandler<P>	A bound asynchronous event handler is an instance of AsyncObjectEventHandler that is permanently bound to a dedicated RealtimeThread.
Clock	A clock marks the passing of time.
ConfigurationParameters	Configuration parameters provide a way to specify various implementation-dependent parameters such as the Java stack and native stack sizes, and to configure the statically allocated ThrowBoundaryError associated with a Schedulable.
FirstInFirstOutParameters	Same as PriorityParameters except that it is only valid with the FirstInFirstOutScheduler.
FirstInFirstOutReleaseRunner	The default ReleaseRunner that uses a pool of FIFO scheduled realtime threads to run handlers.
FirstInFirstOutScheduler	A version of PriorityScheduler where once a thread is scheduled at a given priority, it runs until it is blocked or is preempted by a higher priority thread.
GarbageCollector	The system shall provide dynamic and static information characterizing the temporal behavior and imposed overhead of any garbage collection algorithm provided by the implementation.
HeapMemory	The HeapMemory class is a singleton object that allows logic with a non-heap allocation context to allocate objects in the Java heap.
HighResolutionTime<T extends HighResolutionTime<T>>	Class HighResolutionTime is the base class for AbsoluteTime and RelativeTime.
ImmortalMemory	ImmortalMemory is a memory resource that is unexceptionally available to all schedulables and Java threads for use and allocation.
ImmortalMemoryPermission	Memory permission are divided into those for the core module and those for the memory module.
ImmortalPhysicalMemory	Deprecated since RTSJ 2.0
ImportanceParameters	Deprecated since RTSJ 2.0
LTMemory	Deprecated since RTSJ 2.0; moved to package javax.realtime.memory.
LTPhysicalMemory	Deprecated since RTSJ 2.0
MemoryArea	MemoryArea is the abstract base class of all classes dealing with the representations of allocatable memory areas, including the immortal memory area, physical memory and scoped memory areas.
MemoryParameters	Memory parameters can be given on the constructor of any Schedulable.
MonitorControl	Abstract superclass for all monitor control policies.
NoHeapRealtimeThread	Deprecated since RTSJ 2.0
OneShotTimer	A timed AsyncEvent that is driven by a Clock.
PerennialMemory	A base class for all memory areas whose contents can be unexceptionally referenced.
PeriodicParameters	This release parameter indicates that the schedulable is released on a regular basis.
PeriodicTimer	An AsyncEvent whose fire method is executed periodically according to the given parameters.
PhysicalMemoryManager	Deprecated as of RTSJ 2.0
POSIXSignalHandler	Deprecated since RTSJ 2.0
PriorityCeilingEmulation	Monitor control class specifying the use of the priority ceiling emulation protocol (also known as the "highest lockers" protocol).
PriorityInheritance	Singleton class specifying use of the priority inheritance protocol.
PriorityParameters	Instances of this class should be assigned to schedulables that are managed by schedulers which use a single integer to determine execution order.
PriorityScheduler	Class which represents the required (by the RTSJ) priority-based schedulers.
ProcessingGroupParameters	Deprecated as of RTSJ 2.0; replaced by ProcessingConstraint.
RationalTime	Deprecated as of RTSJ 1.0.1
RawMemoryAccess	Deprecated as of RTSJ 2.0.
RawMemoryFloatAccess	Deprecated as of RTSJ 2.0.
RealtimePermission	All permission classes in the RTSJ inherit from this class.
RealtimeSecurity	Deprecated since RTSJ 2.0
RealtimeSystem	RealtimeSystem provides a means for tuning the behavior of the implementation by specifying parameters such as the maximum number of locks that can be in use concurrently, and the monitor control policy.
RealtimeThread	Class RealtimeThread extends Thread and adds access to realtime services such as advanced scheduling, affinity management, asynchronous transfer of control, and access to scope memory.
RealtimeThreadGroup	An enhanced ThreadGroup in which a RealtimeThread instance may be started, as well as a convention Thread.
RelativeTime	An object that represents a time interval milliseconds/103 + nanoseconds/109 seconds long.
ReleaseParameters<T extends ReleaseParameters<T>>	The top-level class for release characteristics used by Schedulable.
ReleaseRunner	Manages a pool of threads to execute asynchronous event handler releases.
Scheduler	An instance of Scheduler manages the execution of schedulables.
SchedulingParameters	Subclasses of SchedulingParameters (PriorityParameters, ImportanceParameters, and any others parameters defined for particular schedulers) provide the parameters to be used by the Scheduler.
SchedulingPermission	Scheduling has its own security permission that covers APIs in Scheduler, RealtimeThreadGroup, and ProcessingConstraint.
ScopedMemory	Deprecated in RTSJ 2.0; moved to package javax.realtime.memory
SizeEstimator	This class maintains an estimate of the amount of memory required to store a set of objects.
SporadicParameters	A notice to the scheduler that the associated schedulable will be released aperiodically but with a minimum time between releases.
StaticThrowableStorage	Provides the methods for managing the thread local memory used for storing the data needed by preallocated throwables, i.e., exceptions and errors which implement StaticThrowable.
TaskPermission	Task permissions are for controlling threads and handlers, as well as creating clocks.
TimeDispatcher	A dispatcher for time events: Timer and RealtimeThread.sleep(javax.realtime.HighResolutionTime<?>).
TimePermission	Time permissions are for controlling clocks and timers.
Timer	A timer is a timed event that measures time according to a given Clock.
VTMemory	Deprecated as of RTSJ 2.0
VTPhysicalMemory	Deprecated since RTSJ 2.0
WaitFreeDequeue	Deprecated as of RTSJ 1.0.1
WaitFreeReadQueue<T>	A queue that can be non-blocking for consumers.
WaitFreeWriteQueue<T>	A queue that can be non-blocking for producers.

Enum Summary

Enum	Description
ByteOrder	Defines the possible mappings between bytes and words in memory.
EnclosedType	Represents type size classes for deciding how large a lambda is.
MinimumInterarrivalPolicy	Defines the set of policies for handling interarrival time violations in SporadicParameters.
PhasingPolicy	This class defines a set of constants that specify the supported policies for starting a periodic thread or periodic timer, when it is started later than the assigned absolute time.
QueueOverflowPolicy	Defines the set of policies for handling overflow on event queues used by ReleaseParameters.
RTSJModule	Modules an RTSJ implementation may provide.

Exception Summary

Exception	Description
ArrivalTimeQueueOverflowException	When an arrival time occurs and should be queued, but the queue already holds a number of times equal to the initial queue length, an instance of this class is thrown.
AsynchronouslyInterruptedException	Deprecated in RTSJ 2.0; moved to package javax.realtime.control
BackingStoreAllocationException	This error is thrown on an attempt to refer to an object in an inaccessible MemoryArea.
CeilingViolationException	This exception is thrown when a schedulable or java.lang.Thread attempts to lock an object governed by an instance of PriorityCeilingEmulation and the thread or SO's base priority exceeds the policy's ceiling.
ConstructorCheckedException	To throw when MemoryArea.newInstance(java.lang.Class<T>) causes the constructor of the new instance to throw a checked exception.
DeregistrationException	An exception to throw when trying to deregister an ActiveEvent from an ActiveEventDispatcher to which it is not registered.
DuplicateFilterException	Deprecated since RTSJ 2.0
EventQueueOverflowException	When an arrival time occurs and should be queued, but the queue already holds a number of times equal to the initial queue length, an instance of this class is thrown.
ForEachTerminationException	An exception to throw when a visitor should terminate early.
IllegalTaskStateException	The exception thrown when a Schedulable instance attempts an operation which is illegal in its current state.
InaccessibleAreaException	The specified memory area is not on the current thread's scope stack.
LateStartException	Exception thrown when a periodic realtime thread or timer is started after its assigned, absolute, start time.
MemoryInUseException	There has been attempt to allocate a range of physical or virtual memory that is already in use.
MemoryScopeException	When construction of any of the wait-free queues is attempted with the ends of the queue in incompatible memory areas.
MemoryTypeConflictException	This exception is thrown when the PhysicalMemoryManager is given conflicting specifications for memory.
MITViolationException	Thrown by the AsyncEvent.fire() on a minimum interarrival time violation.
OffsetOutOfBoundsException	When the constructor of an ImmortalPhysicalMemory, LTPhysicalMemory, VTPhysicalMemory, RawMemoryAccess, or RawMemoryFloatAccess is given an invalid address.
POSIXInvalidSignalException	An invalid POSIX signal number has been specified.
POSIXInvalidTargetException	The target of the signal does not exist.
POSIXSignalPermissionException	The process does not have permission to send the given signal to the given target.
ProcessorAffinityException	Exception used to report processor affinity-related errors.
RangeOutOfBoundsException	Thrown when the memory region overlaps with another region in use or memory that may not be used.
RegistrationException	An exception to throw when trying to register an ActiveEvent with an ActiveEventDispatcher to which it is already registered.
ScopedCycleException	Thrown when a schedulable attempts to enter an instance of ScopedMemory where that operation would cause a violation of the single parent rule.
SizeOutOfBoundsException	To throw when the constructor of an ImmortalPhysicalMemory, LTPhysicalMemory, or VTPhysicalMemory is given an invalid size or when a memory access generated by a raw memory accessor instance (See RawMemory.) would cause access to an invalid address.
StaticCheckedException	A base class for all checked exceptions defined in the specification which do not extend a conventional Java exception.
StaticIllegalArgumentException	A version of IllegalArgumentException to be thrown by RTSJ methods that does not require allocation.
StaticIllegalStateException	The exception thrown when a Schedulable instance attempts to access a memory which is illegal in the memories current state.
StaticRuntimeException	A base class for all unchecked exceptions defined in the specification which do not extend a conventional Java exception.
StaticSecurityException	A version of SecurityException to be thrown by RTSJ methods that does not require allocation.
StaticUnsupportedOperationException	A version of UnsupportedOperationException to be thown by RTSJ methods that does not require allocation.
Timed	Deprecated in RTSJ 2.0; moved to package javax.realtime.control
UninitializedStateException	Thrown when a resource is not yet initialized, such as a Clock which cannot be created yet because its data source is not yet available.
UnknownHappeningException	Deprecated since RTSJ 2.0
UnsupportedPhysicalMemoryException	Deprecated as of RTSJ 2.0
UnsupportedRawMemoryRegionException	Indicates an invalid raw memory region.

Error Summary

Error	Description
AlignmentError	The exception thrown on a request for a raw memory factory to return memory for a base address that is aligned such that the factory cannot guarantee that loads and stores based on that address will meet the factory's specifications.
IllegalAssignmentError	The exception thrown on an attempt to make an illegal assignment.
MemoryAccessError	This error is thrown on an attempt to refer to an object in an inaccessible MemoryArea.
ResourceLimitError	This error is thrown when an attempt is made to exceed a system resource limit, such as the maximum number of locks.
StaticError	A base class for all errors defined in the specification which do not extend a conventional Java error.
StaticOutOfMemoryError	A version of OutOfMemoryError that does not require allocation.
ThrowBoundaryError	The error thrown by MemoryArea.enter(Runnable logic) when a Throwable allocated from memory that is not usable in the surrounding scope tries to propagate out of the scope of the enter.

Annotation Types Summary

Annotation Type	Description
ReturnsThis	When true, which is the default, indicates that a method returns the object upon which it has been called; hence, the return value may be safely ignored.
StaticThrowable.Hidden	A marker for static throwable support methods that should not be seen in a stack trace.

Package javax.realtime Description

This package encapsulates the core RTSJ module.

Since:

RTSJ 2.0