org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720

Interface ProgrammingService

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.RpcService

public interface ProgrammingService
extends org.opendaylight.yangtools.yang.binding.RpcService

Interface for implementing the following YANG RPCs defined in module programming

 rpc clean-instructions {
     "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.";
     input {
         leaf-list id {
             type instruction-id;
         }
     }
     
     output {
         leaf-list unflushed {
             type instruction-id;
         }
     }
 }
 rpc cancel-instruction {
     input {
         leaf id {
             type instruction-id;
         }
     }
     
     output {
         leaf failure {
             type identityref;
         }
     }
 }
 

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<CancelInstructionOutput>>	cancelInstruction(CancelInstructionInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<CleanInstructionsOutput>>	cleanInstructions(CleanInstructionsInput input) Attempt to clean out a certain set of instructions.

Method Detail

cleanInstructions

Future<org.opendaylight.yangtools.yang.common.RpcResult<CleanInstructionsOutput>> cleanInstructions(CleanInstructionsInput input)

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.

cancelInstruction

Future<org.opendaylight.yangtools.yang.common.RpcResult<CancelInstructionOutput>> cancelInstruction(CancelInstructionInput input)