javax.realtime.posix

Class SignalDispatcher

java.lang.Object

javax.realtime.ActiveEventDispatcher<SignalDispatcher,Signal>

javax.realtime.posix.SignalDispatcher

public final class SignalDispatcher
extends ActiveEventDispatcher<SignalDispatcher,Signal>

Provides a means of dispatching a set of Signal 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 AsyncEvent.fire() method on the instance of Signal associated with the signal each time its signal is triggered.

Since:

RTSJ 2.0

Constructor Summary

Constructors

Constructor and Description
SignalDispatcher(SchedulingParameters scheduling) Creates a new dispatcher, whose dispatching thread runs with the given SchedulingParameters.
SignalDispatcher(SchedulingParameters scheduling, 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(Signal signal) Activate an active event registered with this dispatcher.
protected void	deactivate(Signal signal) Deactivate an active event registered with this dispatcher.
protected void	deregister(Signal 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 SignalDispatcher	getDefaultDispatcher()
boolean	isRegistered(Signal signal) Test wether or not a given event is registered with this dispatcher.
protected void	register(Signal signal) Registers an active event with this dispatcher.
static void	setDefaultDispatcher(SignalDispatcher dispatcher) Sets the system default signal dispatcher.
void	trigger(int signal)

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

SignalDispatcher

public SignalDispatcher(SchedulingParameters scheduling,
                        RealtimeThreadGroup group)

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

Parameters:

scheduling - Parameters for scheduling this dispatcher.

group - Container for this dispatcher.

SignalDispatcher

public SignalDispatcher(SchedulingParameters scheduling)

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

Parameters:

scheduling - For scheduling this dispatcher.

Method Detail

getDefaultDispatcher

public static SignalDispatcher getDefaultDispatcher()

setDefaultDispatcher

public static void setDefaultDispatcher(SignalDispatcher dispatcher)

Sets the system default signal dispatcher.

Parameters:

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

isRegistered

public boolean isRegistered(Signal signal)

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

Specified by:

isRegistered in class ActiveEventDispatcher<SignalDispatcher,Signal>

Parameters:

signal - The event to test

Returns:

true when event is registered with this dispatcher.

register

protected void register(Signal 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<SignalDispatcher,Signal>

Throws:

RegistrationException - when event is already registered.

StaticIllegalStateException - when this object has been destroyed.

Parameters:

signal - The event to register

activate

protected void activate(Signal signal)
                 throws StaticIllegalArgumentException

Activate an active event registered with this dispatcher.

Overrides:

activate in class ActiveEventDispatcher<SignalDispatcher,Signal>

Throws:

StaticIllegalArgumentException

Parameters:

signal - The event to register

deregister

protected void deregister(Signal 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<SignalDispatcher,Signal>

Throws:

StaticIllegalStateException - when this object has been destroyed

DeregistrationException

Parameters:

signal - The event to deregister

deactivate

protected void deactivate(Signal signal)
                   throws StaticIllegalArgumentException

Deactivate an active event registered with this dispatcher.

Overrides:

deactivate in class ActiveEventDispatcher<SignalDispatcher,Signal>

Throws:

StaticIllegalArgumentException - when event is not stopped or is null.

Parameters:

signal - The event to deregister

trigger

public void trigger(int signal)

destroy

public void destroy()
             throws StaticIllegalStateException

Releases all reasources thereby making the dispatcher unusable.

Specified by:

destroy in class ActiveEventDispatcher<SignalDispatcher,Signal>

Throws:

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