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 RealtimeSignal instances, each when its respective signal is triggered. An application can provide its own dispatcher, providing the priority for the internal dispatching thread. This dispatching thread calls the AsyncLongEvent.fire(long) method on the instance of RealtimeSignal associated with the signal each time its 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
protected void	activate(RealtimeSignal signal) Activate an active event registered with this dispatcher.
protected void	deactivate(RealtimeSignal signal) Deactivate an active event registered with this dispatcher.
protected void	deregister(RealtimeSignal signal) Deregisters an active event from this dispatcher, breaking its association with this dispatcher.
void	destroy() Releases all reasources thereby making the dispatcher unusable.
static RealtimeSignalDispatcher	getDefaultDispatcher()
boolean	isRegistered(RealtimeSignal signal) Test wether or not a given event is registered with this dispatcher.
protected void	register(RealtimeSignal signal) Registers an active event with this dispatcher.
static void	setDefaultDispatcher(RealtimeSignalDispatcher dispatcher) Sets the system default realtime signal dispatcher.
void	trigger(int signal, long payload)

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

RealtimeSignalDispatcher

public RealtimeSignalDispatcher(SchedulingParameters schedule,
                                RealtimeThreadGroup group)

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

Throws:

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

Parameters:

schedule - Provides scheduling information to the new object. When affinity is specified, this affinity has to be valid and to be a subset of the affinity of the realtime thread group specified in the group parameter. When the affinity is not specified in schedule or when schedule is null, the affinity will be assumed to be the affinity of the creating task.

group - The RealtimeThreadGroup of the thread of this dispatcher. When null, the closest instance of RealtimeThreadGroup in the hierarchy of thread groups containg the calling task is used.

RealtimeSignalDispatcher

public RealtimeSignalDispatcher(SchedulingParameters schedule)

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

Throws:

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

Parameters:

schedule - Parameters for scheduling this dispatcher.

Method Detail

getDefaultDispatcher

public static RealtimeSignalDispatcher getDefaultDispatcher()

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.

isRegistered

public boolean isRegistered(RealtimeSignal signal)

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

Specified by:

isRegistered in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Parameters:

signal - The event to test

Returns:

true when event is registered with this dispatcher.

register

protected void register(RealtimeSignal signal)
                 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<RealtimeSignalDispatcher,RealtimeSignal>

Throws:

RegistrationException - when event is already registered.

StaticIllegalStateException - when this object has been destroyed.

Parameters:

signal - The event to register

activate

protected void activate(RealtimeSignal signal)
                 throws StaticIllegalArgumentException

Activate an active event registered with this dispatcher.

Overrides:

activate in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Throws:

StaticIllegalArgumentException

Parameters:

signal - The event to register

deregister

protected void deregister(RealtimeSignal signal)
                   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<RealtimeSignalDispatcher,RealtimeSignal>

Throws:

StaticIllegalStateException - when this object has been destroyed

DeregistrationException

Parameters:

signal - The event to deregister

deactivate

protected void deactivate(RealtimeSignal signal)
                   throws StaticIllegalArgumentException

Deactivate an active event registered with this dispatcher.

Overrides:

deactivate in class ActiveEventDispatcher<RealtimeSignalDispatcher,RealtimeSignal>

Throws:

StaticIllegalArgumentException - when event is not stopped or is null.

Parameters:

signal - The event to deregister

trigger

public void trigger(int signal,
                    long payload)

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.