javax.realtime

Class TimeDispatcher

java.lang.Object

javax.realtime.ActiveEventDispatcher<TimeDispatcher,Timable>

javax.realtime.TimeDispatcher

public final class TimeDispatcher
extends ActiveEventDispatcher<TimeDispatcher,Timable>

A dispatcher for time events: Timer and RealtimeThread.sleep(javax.realtime.Clock, javax.realtime.HighResolutionTime<?>).

Since:

RTSJ 2.0

Constructor Summary

Constructors

Constructor and Description
TimeDispatcher(SchedulingParameters schedule) Creates a new dispatcher, whose dispatching thread runs with the given scheduling parameters.
TimeDispatcher(SchedulingParameters schedule, RealtimeThreadGroup group) Creates a new dispatcher, whose dispatching thread runs with the given scheduling parameters.

Method Summary

Modifier and Type	Method and Description
void	deregister(Timable target) Deregisters a Timable from this dispatcher.
void	destroy() Releases all resources thereby making the dispatcher unusable.
void	register(Timable target) Registers a Timable with this dispatcher.
static void	setDefaultDispatcher(TimeDispatcher dispatcher) Sets the system default time dispatcher.

Methods inherited from class javax.realtime.ActiveEventDispatcher

getRealtimeThreadGroup, getScheduler, getSchedulingParameters, setScheduler, setScheduler, setSchedulingParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDispatcher

public TimeDispatcher(SchedulingParameters schedule,
                      RealtimeThreadGroup group)
               throws StaticIllegalStateException

Creates a new dispatcher, whose dispatching thread runs with the given scheduling parameters.

Parameters:

schedule - It gives the parameters for scheduling this dispatcher

Throws:

StaticIllegalStateException - when the intersection of affinity in schedule and the affinity of group does not correspond to a valid affinity.

java.lang.UnsupportedOperationException - every time, since this is not implemented yet.

TimeDispatcher

public TimeDispatcher(SchedulingParameters schedule)
               throws StaticIllegalStateException

Creates a new dispatcher, whose dispatching thread runs with the given scheduling parameters.

Parameters:

schedule - It gives the parameters for scheduling this dispatcher

Throws:

StaticIllegalStateException - when the intersection of affinity in schedule and the affinity of the current rhread groupo does not correspond to a valid affinity.

java.lang.UnsupportedOperationException - every time, since this is not implemented yet.

Method Detail

setDefaultDispatcher

public static void setDefaultDispatcher(TimeDispatcher dispatcher)

Sets the system default time dispatcher.

Parameters:

dispatcher - To be used when no dispatcher is provided. When null, the default time dispatcher is set to the original system default.

Throws:

java.lang.UnsupportedOperationException - every time, since this is not implemented yet.

register

public void register(Timable target)
              throws RegistrationException,
                     StaticIllegalStateException,
                     StaticIllegalArgumentException

Registers a Timable with this dispatcher.

Specified by:

register in class ActiveEventDispatcher<TimeDispatcher,Timable>

Parameters:

target - To be registered

Throws:

RegistrationException - when target is already registered.

StaticIllegalStateException - when this object has been destroyed.

StaticIllegalArgumentException - when target is not stopped.

java.lang.UnsupportedOperationException - every time, since this is not implemented yet.

deregister

public void deregister(Timable target)
                throws DeregistrationException,
                       StaticIllegalStateException,
                       StaticIllegalArgumentException

Deregisters a Timable from this dispatcher.

Specified by:

deregister in class ActiveEventDispatcher<TimeDispatcher,Timable>

Parameters:

target - to be deregistered

Throws:

DeregistrationException - when target is not already registered.

StaticIllegalStateException - when this object has been destroyed.

StaticIllegalArgumentException - when target is not stopped.

java.lang.UnsupportedOperationException - every time, since this is not implemented yet.

destroy

public void destroy()
             throws StaticIllegalStateException

Releases all resources thereby making the dispatcher unusable.

Specified by:

destroy in class ActiveEventDispatcher<TimeDispatcher,Timable>

Throws:

StaticIllegalStateException - when called on a dispatcher that has one or more registered Timable objects.