SignalApi (scheduling 13.1.0-SNAPSHOT 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
`Map<String,Map<String,String>>`	`checkForSignals(Set<String> signalsSubSet)` Check if all 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
`Map<String,Signal>`	`getJobSignals()` Return the set of job signals
`boolean`	`isReceived(String signalName)` Check if the given signal was received
`void`	`readyForSignal(String signalName)` Add a new signal to the set of job signals
`void`	`readyForSignal(String signalName, List<JobVariable> variables)` Add a new signal to the set of job signals
`void`	`removeManySignals(Set<String> signalsSubSet)` Remove the given set of signals from job signals In order to remove signals that were not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal names
`void`	`removeSignal(String signal)` Remove the given `signal` from the set of job signals In order to remove a signal that was not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal name
`void`	`sendManySignals(Map<String,Map<String,String>> signalParameters)` Add the given set of signals to job signals
`void`	`sendManySignals(Set<String> signalsSubSet)` Add the given set of signals to job signals
`void`	`sendSignal(String signalName)` Add the given `signal` to the set of job signals
`void`	`sendSignal(String signalName, Map<String,String> parameters)` Add the given `signal` to the set of job signals
`Map<String,String>`	`waitFor(String signalName)` Wait until the given signal is added to the set of job signals
`Map<String,Map<String,String>>`	`waitForAll(Set<String> signalsSubSet)` Wait until all the input signals are added to the set of job signals
`Signal`	`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
```
void readyForSignal(String signalName)
             throws SignalApiException
```
    Add a new signal to the set of job signals
    
    Parameters:
    
    signalName - name of the signal to be added
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the ready signal to job signals
  - readyForSignal
```
void readyForSignal(String signalName,
                    List<JobVariable> variables)
             throws SignalApiException
```
    Add a new signal to the set of job signals
    
    Parameters:
    
    signalName - name of the signal to be added
    
    variables - the input variables of the signal to be added
    
    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 signalName)
            throws SignalApiException
```
    Check if the given signal was received
    
    Parameters:
    
    signalName - name of the signal to be checked
    
    Returns:
    
    true if the signal was received
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - checkForSignals
```
Map<String,Map<String,String>> checkForSignals(Set<String> signalsSubSet)
                                        throws SignalApiException
```
    Check if all of the signals given as input exist among the set of job signals
    
    Parameters:
    
    signalsSubSet - set of the signals to be checked
    
    Returns:
    
    the the map of signals names and updatedVariables found in the set of job signals, empty map if no signals are found
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitFor
```
Map<String,String> waitFor(String signalName)
                    throws SignalApiException
```
    Wait until the given signal is added to the set of job signals
    
    Parameters:
    
    signalName - name of the signal to wait for
    
    Returns:
    
    a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitForAny
```
Signal 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
```
Map<String,Map<String,String>> 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
    
    Returns:
    
    a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - sendSignal
```
void sendSignal(String signalName)
         throws SignalApiException
```
    Add the given signal to the set of job signals
    
    Parameters:
    
    signalName - name of the signal to be added to job signals
    
    Throws:
    
    SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal
  - sendSignal
```
void sendSignal(String signalName,
                Map<String,String> parameters)
         throws SignalApiException
```
    Add the given signal to the set of job signals
    
    Parameters:
    
    signalName - name of the signal to be added to job signals
    
    parameters - the updated values of the signal to be added
    
    Throws:
    
    SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal
  - sendManySignals
```
void 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
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals
  - sendManySignals
```
void sendManySignals(Map<String,Map<String,String>> signalParameters)
              throws SignalApiException
```
    Add the given set of signals to job signals
    
    Parameters:
    
    signalParameters - a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals
  - removeSignal
```
void removeSignal(String signal)
           throws SignalApiException
```
    Remove the given signal from the set of job signals In order to remove a signal that was not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal name
    
    Parameters:
    
    signal - name of the signal to be removed from job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when removing the signal from job signals
  - removeManySignals
```
void removeManySignals(Set<String> signalsSubSet)
                throws SignalApiException
```
    Remove the given set of signals from job signals In order to remove signals that were not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal names
    
    Parameters:
    
    signalsSubSet - set of the signals to be 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
```
Map<String,Signal> getJobSignals()
                          throws SignalApiException
```
    Return the set of job signals
    
    Returns:
    
    a map containing the signal name and the Signal object
    
    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

readyForSignal

isReceived

checkForSignals

waitFor

waitForAny

waitForAll

sendSignal

sendSignal

sendManySignals

sendManySignals

removeSignal

removeManySignals

getJobSignals

clearJobSignals