Interface ProgrammingService

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.RpcService
    All Known Implementing Classes:
    ProgrammingServiceImpl

    @Generated("mdsal-binding-generator")
    public interface ProgrammingService
    extends org.opendaylight.yangtools.yang.binding.RpcService
    Interface for implementing the following YANG RPCs defined in module programming
     rpc cancel-instruction {
       input input {
         leaf id {
           type instruction-id;
         }
       }
       output output {
         leaf failure {
           type identityref {
             base cancel-failure;
           }
         }
       }
     }
     rpc clean-instructions {
       input input {
         leaf-list id {
           type instruction-id;
           min-elements 1;
         }
       }
       output output {
         leaf-list unflushed {
           type instruction-id;
         }
       }
     }
     
    • Method Detail

      • cancelInstruction

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CancelInstructionOutput>> cancelInstruction​(CancelInstructionInput input)
        Invoke cancel-instruction RPC.
        Parameters:
        input - of cancel-instruction
        Returns:
        output of cancel-instruction
      • cleanInstructions

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CleanInstructionsOutput>> cleanInstructions​(CleanInstructionsInput input)
        Invoke clean-instructions RPC.
             
                 Attempt to clean out a certain set of instructions. Instructions flushed this
                 way need to be in a terminal state, e.g. Successful, Failed or Cancelled.
                 Instructions which were not cleaned are reported in the output of this RPC.
             
         
        Parameters:
        input - of clean-instructions
        Returns:
        output of clean-instructions