Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.IMRU.API.IJobCancelledDetector Interface Reference

The interface is used by IMRU driver to detect if job was cancelled. More...

Inherited by Org.Apache.REEF.IMRU.OnREEF.Driver.JobCancellationDetectorAlwaysFalse.

Public Member Functions

bool IsJobCancelled (out string cancellationMessage)
 Is used to check for cancellation signal More...
 

Detailed Description

The interface is used by IMRU driver to detect if job was cancelled.

By default no cancellation events are implemented. Client can set specific implementation of the interface when creating job definition. For instance IMRU job can be cancelled when client application is cancelled.

Member Function Documentation

◆ IsJobCancelled()

bool Org.Apache.REEF.IMRU.API.IJobCancelledDetector.IsJobCancelled ( out string  cancellationMessage)

Is used to check for cancellation signal

Parameters
cancellationMessagedetails about cancellation event
Returns
true if cancellation signal is detected, false - otherwise

The documentation for this interface was generated from the following file: