Package org.opendaylight.bgpcep.programming.spi

Interface InstructionScheduler

All Superinterfaces:
AutoCloseable, org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>, org.opendaylight.yangtools.concepts.Registration
public interface InstructionScheduler extends org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier>, org.opendaylight.yangtools.concepts.Registration

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getInstructionID()
    Returns InstructionID.
    com.google.common.util.concurrent.ListenableFuture<Instruction>
    scheduleInstruction(SubmitInstructionInput input)
    Schedule a new instruction for execution.

    Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

    getIdentifier

    Methods inherited from interface org.opendaylight.yangtools.concepts.Registration

    close

  • Method Details

    • 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