Interface ToasterService

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.RpcService

    @Generated("mdsal-binding-generator")
    public interface ToasterService
    extends org.opendaylight.yangtools.yang.binding.RpcService
    Interface for implementing the following YANG RPCs defined in module toaster
     rpc make-toast {
       input input {
         leaf toasterDoneness {
           type uint32 {
             range "1 .. 10";
           }
           default 5;
         }
         leaf toasterToastType {
           type identityref {
             base toast-type;
           }
           default wheat-bread;
         }
       }
     }
     rpc cancel-toast {
     }
     rpc restock-toaster {
       input input {
         leaf amountOfBreadToStock {
           type uint32;
         }
       }
     }
     
    • Method Detail

      • makeToast

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<MakeToastOutput>> makeToast​(MakeToastInput input)
        Invoke make-toast RPC.
             
                 Make some toast. The toastDone notification will be sent when the toast is
                 finished. An 'in-use' error will be returned if toast is already being made. A
                 'resource-denied' error will be returned if the toaster service is disabled.
             
         
        Parameters:
        input - of make-toast
        Returns:
        output of make-toast
      • cancelToast

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<CancelToastOutput>> cancelToast​(CancelToastInput input)
        Invoke cancel-toast RPC.
             
                 Stop making toast, if any is being made. A 'resource-denied' error will be
                 returned if the toaster service is disabled.
             
         
        Parameters:
        input - of cancel-toast
        Returns:
        output of cancel-toast
      • restockToaster

        @CheckReturnValue
        com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<RestockToasterOutput>> restockToaster​(RestockToasterInput input)
        Invoke restock-toaster RPC.
             
                 Restocks the toaster with the amount of bread specified.
             
         
        Parameters:
        input - of restock-toaster
        Returns:
        output of restock-toaster