org.opentcs.drivers.peripherals.PeripheralJobCallback Maven / Gradle / Ivy

Go to download
// SPDX-FileCopyrightText: The openTCS Authors
// SPDX-License-Identifier: MIT
package org.opentcs.drivers.peripherals;

import jakarta.annotation.Nonnull;
import org.opentcs.data.TCSObjectReference;
import org.opentcs.data.peripherals.PeripheralJob;

/**
 * A callback used to inform about the successful or failed completion of jobs.
 */
public interface PeripheralJobCallback {

  /**
   * Called on successful completion of a job.
   * 
   * This method is supposed to be called only from the kernel executor thread.
   * 
   *
   * @param ref A reference to the peripheral job that was successfully completed.
   */
  void peripheralJobFinished(
      @Nonnull
      TCSObjectReference ref
  );

  /**
   * Called on failed completion of a job.
   * 
   * This method is supposed to be called only from the kernel executor thread.
   * 
   *
   * @param ref A reference to the peripheral job whose completion has failed.
   */
  void peripheralJobFailed(
      @Nonnull
      TCSObjectReference ref
  );
}