dev.bpmcrafters.processengineapi.correlation.SignalApi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of process-engine-api Show documentation

Java API for engine-independent process functionality.

There is a newer version: 0.3.0

package dev.bpmcrafters.processengineapi.correlation

import dev.bpmcrafters.processengineapi.Empty
import dev.bpmcrafters.processengineapi.MetaInfoAware
import dev.bpmcrafters.processengineapi.RestrictionAware
import java.util.concurrent.Future

/**
 * API to send signals to running process instances.
 * @since 0.0.1
 */
interface SignalApi : MetaInfoAware, RestrictionAware {

  /**
   * Delivers a signal event to process engine.
   * @param cmd command to deliver.
   * @return future to indicate completion.
   */
  fun sendSignal(cmd: SendSignalCmd): Future
}