org.lsst.ccs.framework

Interface SignalHandler

public interface SignalHandler

A component that can receive a Signal. A default implementation for this functional interface should return TreeWalkerDiag.GO

Author:

bamade

Method Summary

Modifier and Type	Method and Description
default void	sendSignal(String signalString) command to send a signal.
default void	sendSignalWithTimeLimit(String signalString, long expectedMaxDelay) command to send a signal with a delay for execution.
default TreeWalkerDiag	signal(Signal sig) this method is intended for overriding: the module receives an out of band signal.

Method Detail

signal

default TreeWalkerDiag signal(Signal sig)

this method is intended for overriding: the module receives an out of band signal. Beware this code is executed in a different thread (take care of threading issued when overriding)

Parameters:

sig -

Returns:

one of the TreeWalkerDiag options to tell the subsystem to continue to call this on child components or not.

sendSignal

@Command(description="will propagate signal to Module and its children ",
         type=SIGNAL)
default void sendSignal(String signalString)

command to send a signal.

Parameters:

signalString - string representing a member of an enum of type SignalLevel

sendSignalWithTimeLimit

@Command(description="will propagate signal to Module and its children with  an expected maximum delay",
         type=SIGNAL)
default void sendSignalWithTimeLimit(String signalString,
                                                                                                                                                                    long expectedMaxDelay)

command to send a signal with a delay for execution.

Parameters:

signalString - string representing a member of an enum of type SignalLevel

expectedMaxDelay -