Package org.opentcs.drivers.peripherals
Interface PeripheralJobCallback
public interface PeripheralJobCallback
A callback used to inform about the successful or failed completion of jobs.
-
Method Summary
Modifier and Type Method Description voidperipheralJobFailed(PeripheralJob job)Deprecated.default voidperipheralJobFailed(TCSObjectReference<PeripheralJob> ref)Called on failed completion of a job.voidperipheralJobFinished(PeripheralJob job)Deprecated.default voidperipheralJobFinished(TCSObjectReference<PeripheralJob> ref)Called on successful completion of a job.
-
Method Details
-
peripheralJobFinished
@Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") void peripheralJobFinished(@Nonnull PeripheralJob job)Deprecated.Called on successful completion of a job.This method is supposed to be called only from the kernel executor thread.
- Parameters:
job- The job that was successfully completed.
-
peripheralJobFailed
@Deprecated @ScheduledApiChange(when="6.0", details="Will be removed.") void peripheralJobFailed(@Nonnull PeripheralJob job)Deprecated.Called on failed completion of a job.This method is supposed to be called only from the kernel executor thread.
- Parameters:
job- The job whose completion has failed.
-
peripheralJobFinished
@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void peripheralJobFinished(@Nonnull TCSObjectReference<PeripheralJob> ref)Called on successful completion of a job.This method is supposed to be called only from the kernel executor thread.
- Parameters:
ref- A reference to the peripheral job that was successfully completed.
-
peripheralJobFailed
@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void peripheralJobFailed(@Nonnull TCSObjectReference<PeripheralJob> ref)Called on failed completion of a job.This method is supposed to be called only from the kernel executor thread.
- Parameters:
ref- A reference to the peripheral job whose completion has failed.
-