javax.realtime.posix

Class RealtimeSignalDispatcher

java.lang.Object

javax.realtime.ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

javax.realtime.posix.RealtimeSignalDispatcher

public final class RealtimeSignalDispatcher
extends ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Provides a means of dispatching a set of RealtimeSignals. An application can provide its own dispatcher, providing the priority for the internal dispatching thread. This dispatching thread calls process() each time the signal is triggered.

Since:

RTSJ 2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deregister(RealtimeSignal signal) Deregisters the signal from this dispatcher.
void	destroy() Releases all reasources thereby making the dispatcher unusable.
void	register(RealtimeSignal signal) Registers signal with this dispatcher.
static void	setDefaultDispatcher(RealtimeSignalDispatcher dispatcher) Sets the system default realtime signal 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

RealtimeSignalDispatcher

public RealtimeSignalDispatcher(SchedulingParameters schedule,
                                RealtimeThreadGroup group)

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

Parameters:

schedule - Parameters for scheduling this dispatcher.

group - Container for this dispatcher.

Throws:

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

RealtimeSignalDispatcher

public RealtimeSignalDispatcher(SchedulingParameters schedule)

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

Parameters:

schedule - Parameters for scheduling this dispatcher.

Throws:

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

Method Detail

setDefaultDispatcher

public static void setDefaultDispatcher(RealtimeSignalDispatcher dispatcher)

Sets the system default realtime signal dispatcher.

Parameters:

dispatcher - The instance to be used when no dispatcher is provided. When null, the realtime signal dispatcher is set to the original system default.

Throws:

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

register

public void register(RealtimeSignal signal)
              throws RegistrationException,
                     StaticIllegalStateException,
                     StaticIllegalArgumentException

Registers signal with this dispatcher.

Specified by:

register in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Parameters:

signal - The signal object to register.

Throws:

RegistrationException - when signal is already registered.

StaticIllegalStateException - when this object has been destroyed.

StaticIllegalArgumentException - when signal is not stopped.

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

deregister

public void deregister(RealtimeSignal signal)
                throws DeregistrationException,
                       StaticIllegalStateException,
                       StaticIllegalArgumentException

Deregisters the signal from this dispatcher.

Specified by:

deregister in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Parameters:

signal - The signal object to deregister.

Throws:

DeregistrationException - when signal is not already registered.

StaticIllegalStateException - when this object has been destroyed.

StaticIllegalArgumentException - when signal is not stopped.

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

destroy

public void destroy()
             throws StaticIllegalStateException

Releases all reasources thereby making the dispatcher unusable.

Specified by:

destroy in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Throws:

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

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