javax.realtime.posix

Class RealtimeSignal

java.lang.Object

javax.realtime.AsyncBaseEvent

javax.realtime.AsyncLongEvent

javax.realtime.posix.RealtimeSignal

All Implemented Interfaces:

ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>, Releasable<RealtimeSignal,RealtimeSignalDispatcher>

public final class RealtimeSignal
extends AsyncLongEvent
implements ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

A ActiveEvent subclass for defining a POSIX realtime signal.

Since:

RTSJ 2.0

Method Summary

Modifier and Type	Method and Description
void	addHandler(AsyncBaseEventHandler handler) Add a handler to the set of handlers associated with this event.
static RealtimeSignal	get(int id) Gets a supported realtime signal by its ID.
static RealtimeSignal	get(String name) Gets a supported realtime signal by its name.
RealtimeSignalDispatcher	getDispatcher() Obtains the dispatcher for this.
int	getId() Gets the name of this realtime signal.
static int	getId(String name) Gets the ID of a supported realtime signal by its name.
String	getName() Gets the name of this signal.
boolean	isActive() Determines the activation state of this signal, i.e., whether or not it has been started.
static boolean	isPOSIXRealtimeSignal(String name) Determines whether or not a signal with a given name is registered.
boolean	isRunning() Determines the firing state (releasing or skipping) of this signal, i.e., whether or not is active and enabled.
void	removeHandler(AsyncBaseEventHandler handler) Remove a handler from the set associated with this event.
boolean	send(long pid, long payload) Sends this signal to another process.
void	setHandler(AsyncBaseEventHandler handler) Associate a new handler with this event and remove all existing handlers.
void	start() Starts this RealtimeSignal, i.e., changes to a running state.
void	start(boolean disabled) Starts this RealtimeSignal, i.e., changes to a running state.
boolean	stop() Stops this RealtimeSignal.

Methods inherited from class javax.realtime.AsyncLongEvent

fire

Methods inherited from class javax.realtime.AsyncBaseEvent

createReleaseParameters, disable, enable, handledBy, hasHandlers

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.realtime.ActiveEvent

disable, enable

Method Detail

isPOSIXRealtimeSignal

public static boolean isPOSIXRealtimeSignal(String name)

Determines whether or not a signal with a given name is registered.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

name - The name of the signal check.

Returns:

true when a signal with the given name is registered.

getId

public static int getId(String name)

Gets the ID of a supported realtime signal by its name.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

name - The name of the signal whose ID should be determined.

Returns:

the ID of the signal named by name.

get

public static RealtimeSignal get(String name)

Gets a supported realtime signal by its name.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

name - The name of the signal to get.

Returns:

the registered signal with name or null.

get

public static RealtimeSignal get(int id)

Gets a supported realtime signal by its ID.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

id - The identifier of a registered signal.

Returns:

the signal corresponding to ID.

getId

public int getId()

Gets the name of this realtime signal.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

the ID of this signal.

getName

public final String getName()

Gets the name of this signal.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

the name of this signal.

getDispatcher

public RealtimeSignalDispatcher getDispatcher()

Obtains the dispatcher for this.

Specified by:

getDispatcher in interface Releasable<RealtimeSignal,RealtimeSignalDispatcher>

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

that dispatcher.

isActive

public boolean isActive()

Determines the activation state of this signal, i.e., whether or not it has been started.

Specified by:

isActive in interface ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

true when active; false otherwise.

isRunning

public boolean isRunning()

Determines the firing state (releasing or skipping) of this signal, i.e., whether or not is active and enabled.

Specified by:

isRunning in interface ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

Overrides:

isRunning in class AsyncBaseEvent

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

true when releasing, false when skipping.

start

public final void start()
                 throws StaticIllegalStateException

Starts this RealtimeSignal, i.e., changes to a running state. A running realtime signal is a source of activation when in a scoped memory and is a member of the root set when in the heap. A running realtime signal can be triggered.

Specified by:

start in interface ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

Throws:

StaticIllegalStateException - when this RealtimeSignal has already been started.

UnsupportedOperationException - everytime, since this is not implemented yet.

See Also:

stop()

start

public final void start(boolean disabled)
                 throws StaticIllegalStateException

Starts this RealtimeSignal, i.e., changes to a running state. A running realtime signal is a source of activation when in a scoped memory and is a member of the root set when in the heap. A running realtime signal can be triggered.

Specified by:

start in interface ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

Throws:

StaticIllegalStateException - when this RealtimeSignal has already been started.

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

disabled - true for starting in a disabled state.

See Also:

stop()

stop

public final boolean stop()
                   throws StaticIllegalStateException

Stops this RealtimeSignal. A stopped realtime signal ceases to be a source of activation and no longer causes any AE attached to it to be a source of activation.

Specified by:

stop in interface ActiveEvent<RealtimeSignal,RealtimeSignalDispatcher>

Throws:

StaticIllegalStateException - when this RealtimeSignal is not running.

UnsupportedOperationException - everytime, since this is not implemented yet.

Returns:

true when this was enabled; false otherwise.

send

public boolean send(long pid,
                    long payload)

Sends this signal to another process.

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

pid - The identifier of the process to which to send the signal.

payload - The long value associated with a fire.

Returns:

true when signal can be sent; otherwise false.

addHandler

public void addHandler(AsyncBaseEventHandler handler)

Add a handler to the set of handlers associated with this event. An instance of AsyncBaseEvent may have more than one associated handler. However, adding a handler to an event has no effect when the handler is already attached to the event The execution of this method is atomic with respect to the execution of the fire() method. Note that there is an implicit reference to the handler stored in this. The assignment must be valid under any applicable memory assignment rules.

Overrides:

addHandler in class AsyncBaseEvent

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

handler - The new handler to add to the list of handlers already associated with this. When handler is already associated with the event, the call has no effect

setHandler

public void setHandler(AsyncBaseEventHandler handler)

Associate a new handler with this event and remove all existing handlers.

Overrides:

setHandler in class AsyncBaseEvent

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

handler - The instance of AsyncBaseEventHandler to be associated with this. When handler is null then no handler will be associated with this, i.e., behave effectively as if setHandler(null) invokes removeHandler(AsyncBaseEventHandler) for each associated handler.

removeHandler

public void removeHandler(AsyncBaseEventHandler handler)

Remove a handler from the set associated with this event. A removed handler continues to execute until its fireCount becomes a zero and it completes. When handler has a scoped non-default initial memory area and execution of this method causes handler to become unfirable this method shall not return until all related finalization has completed

Overrides:

removeHandler in class AsyncBaseEvent

Throws:

UnsupportedOperationException - everytime, since this is not implemented yet.

Parameters:

handler - The handler to be disassociated from this. When null nothing happens. When the handler is not already associated with this then nothing happens