javax.realtime

Class TimeDispatcher

java.lang.Object

javax.realtime.ActiveEventDispatcher<TimeDispatcher,Timer>

javax.realtime.TimeDispatcher

public final class TimeDispatcher
extends ActiveEventDispatcher<TimeDispatcher,Timer>

A dispatcher for time events: Timer and RealtimeThread.sleep(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
protected void	activate(Timer target) Activate an active event registered with this dispatcher.
protected void	deactivate(Timer target) Deactivate an active event registered with this dispatcher.
protected void	deregister(Timer target) Deregisters an active event from this dispatcher, breaking its association with this dispatcher.
void	destroy() Releases all resources thereby making the dispatcher unusable.
static TimeDispatcher	getDefaultDispatcher() Obtain the default dispatcher for timers
boolean	isRegistered(Timer target) Test wether or not a given event is registered with this dispatcher.
protected void	register(Timer target) Registers an active event with this dispatcher.
static void	setDefaultDispatcher(TimeDispatcher dispatcher) Sets the system default time dispatcher.

Methods inherited from class javax.realtime.ActiveEventDispatcher

getRealtimeThreadGroup, getScheduler, getSchedulingParameters, getThread, 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.

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.

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.

getDefaultDispatcher

public static TimeDispatcher getDefaultDispatcher()

Obtain the default dispatcher for timers

Returns:

the current default dispatcher

isRegistered

public boolean isRegistered(Timer target)

Test wether or not a given event is registered with this dispatcher.

Specified by:

isRegistered in class ActiveEventDispatcher<TimeDispatcher,Timer>

Parameters:

target - The event to test

Returns:

true when event is registered with this dispatcher.

register

protected void register(Timer target)
                 throws RegistrationException,
                        StaticIllegalStateException

Registers an active event with this dispatcher. Registering an event prevents the event from being programmatically destroyed, but it may not hold the dispatcher from being collected when the dispatcher is in a more deeply nested scope.

Specified by:

register in class ActiveEventDispatcher<TimeDispatcher,Timer>

Parameters:

target - The event to register

Throws:

RegistrationException - when event is already registered.

StaticIllegalStateException - when this object has been destroyed.

activate

protected void activate(Timer target)
                 throws StaticIllegalStateException

Activate an active event registered with this dispatcher.

Overrides:

activate in class ActiveEventDispatcher<TimeDispatcher,Timer>

Parameters:

target - The event to register

Throws:

StaticIllegalStateException - when event is stopped.

deregister

protected void deregister(Timer target)
                   throws DeregistrationException,
                          StaticIllegalStateException

Deregisters an active event from this dispatcher, breaking its association with this dispatcher. This should only happen when an event is assoicated with another dispather.

Specified by:

deregister in class ActiveEventDispatcher<TimeDispatcher,Timer>

Parameters:

target - The event to deregister

Throws:

StaticIllegalStateException - when this object has been destroyed

DeregistrationException

deactivate

protected void deactivate(Timer target)
                   throws StaticIllegalStateException

Deactivate an active event registered with this dispatcher.

Overrides:

deactivate in class ActiveEventDispatcher<TimeDispatcher,Timer>

Parameters:

target - The event to deregister

Throws:

StaticIllegalStateException - when this object has been destroyed.

destroy

public void destroy()
             throws StaticIllegalStateException

Releases all resources thereby making the dispatcher unusable.

Specified by:

destroy in class ActiveEventDispatcher<TimeDispatcher,Timer>

Throws:

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