Interface InstructionScheduler

  • All Superinterfaces:
    AutoCloseable, org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>
    All Known Implementing Classes:
    ProgrammingServiceImpl

    public interface InstructionScheduler
    extends org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>, AutoCloseable
    • Method Detail

      • scheduleInstruction

        com.google.common.util.concurrent.ListenableFuture<Instruction> scheduleInstruction​(SubmitInstructionInput input)
                                                                                     throws SchedulerException
        Schedule a new instruction for execution. This method tries to enqueue an instruction. It will return a Future which represents the scheduling progress. When the future becomes successful, the requestor is expected to start executing on the instruction, as specified by the Instruction contract.
        Parameters:
        input - Instruction scheduling information
        Returns:
        Scheduling future.
        Throws:
        SchedulerException - if a failure to schedule the instruction occurs.
      • getInstructionID

        @NonNull String getInstructionID()
        Returns InstructionID.
        Returns:
        Instruction ID