SignalApi (scheduling 12.0.8 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

SignalApiImpl
```
@PublicAPI
public interface SignalApi
extends Serializable
```
SignalApi uses the synchronization API store to provide a persistent key/value channel for job signals. SignalApi uses a single system channel to store all signals needed by jobs. The signal channel contains an entry per job. The key of each entry is the job id, whereas the value of the entry is the set of signals used by the considered job. The SignalApi service is automatically started with the ProActive Server.

Since:

24/11/2020

See Also:

org.ow2.proactive.scheduler.synchronization

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`checkForSignals(Set<String> signalsSubSet)` Check if any of the signals given as input exist among the set of job signals
`void`	`clearJobSignals()` Remove the entry corresponding to job signals from the signals channel
`Set<String>`	`getJobSignals()` Return the set of job signals
`boolean`	`isReceived(String signal)` Check if the given signal exists among the set of job signals
`boolean`	`readyForSignal(String signal)` Add a new signal to the set of job signals The new signal is composed of a prefix (i.e., "ready_") and the given signal
`boolean`	`removeManySignals(Set<String> signalsSubSet)` Remove the given set of signals from job signals
`boolean`	`removeSignal(String signal)` Remove the given `signal` from the set of job signals
`boolean`	`sendManySignals(Set<String> signalsSubSet)` Add the given set of signals to job signals
`boolean`	`sendSignal(String signal)` Add the given `signal` to the set of job signals
`void`	`waitFor(String signal)` Wait until the given signal is added to the set of job signals
`void`	`waitForAll(Set<String> signalsSubSet)` Wait until all the input signals are added to the set of job signals
`String`	`waitForAny(Set<String> signalsSubSet)` Wait until one signal (among those of the given `signalsSubSet`) is added to the set of job signals

- Method Detail
  - readyForSignal
```
boolean readyForSignal(String signal)
                throws SignalApiException
```
    Add a new signal to the set of job signals The new signal is composed of a prefix (i.e., "ready_") and the given signal
    
    Parameters:
    
    signal - name of the signal to be added
    
    Returns:
    
    true if the signal is successfully added to the set of job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the ready signal to job signals
  - isReceived
```
boolean isReceived(String signal)
            throws SignalApiException
```
    Check if the given signal exists among the set of job signals
    
    Parameters:
    
    signal - name of the signal to be checked
    
    Returns:
    
    true if the signal exists among the set of job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - checkForSignals
```
String checkForSignals(Set<String> signalsSubSet)
                throws SignalApiException
```
    Check if any of the signals given as input exist among the set of job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to be checked
    
    Returns:
    
    the first signal found in the set of job signals, null if no signals are found
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitFor
```
void waitFor(String signal)
      throws SignalApiException
```
    Wait until the given signal is added to the set of job signals
    
    Parameters:
    
    signal - name of the signal to wait for
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitForAny
```
String waitForAny(Set<String> signalsSubSet)
           throws SignalApiException
```
    Wait until one signal (among those of the given signalsSubSet) is added to the set of job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to wait for any of them
    
    Returns:
    
    the first signal received among those given as input
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitForAll
```
void waitForAll(Set<String> signalsSubSet)
         throws SignalApiException
```
    Wait until all the input signals are added to the set of job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to wait for
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - sendSignal
```
boolean sendSignal(String signal)
            throws SignalApiException
```
    Add the given signal to the set of job signals
    
    Parameters:
    
    signal - name of the signal to be added to job signals
    
    Returns:
    
    true if the signal is successfully added to job signals
    
    Throws:
    
    SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal
  - sendManySignals
```
boolean sendManySignals(Set<String> signalsSubSet)
                 throws SignalApiException
```
    Add the given set of signals to job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to be added to job signals
    
    Returns:
    
    true if all the given signals are successfully added to job signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals
  - removeSignal
```
boolean removeSignal(String signal)
              throws SignalApiException
```
    Remove the given signal from the set of job signals
    
    Parameters:
    
    signal - name of the signal to be removed from job signals
    
    Returns:
    
    true if the signal is successfully removed from the set of job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when removing the signal from job signals
  - removeManySignals
```
boolean removeManySignals(Set<String> signalsSubSet)
                   throws SignalApiException
```
    Remove the given set of signals from job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to be removed from job signals
    
    Returns:
    
    true if all the given signals are successfully removed from job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when removing the signals from job signals
  - getJobSignals
```
Set<String> getJobSignals()
                   throws SignalApiException
```
    Return the set of job signals
    
    Returns:
    
    the set of job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - clearJobSignals
```
void clearJobSignals()
              throws SignalApiException
```
    Remove the entry corresponding to job signals from the signals channel
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when removing an entry from this channel

Interface SignalApi

Method Summary

Method Detail

readyForSignal

isReceived

checkForSignals

waitFor

waitForAny

waitForAll

sendSignal

sendManySignals

removeSignal

removeManySignals

getJobSignals

clearJobSignals