binding/binding-lib/src/main/java/org/opendaylight/yangtools/yang/binding/Rpc.java

   1 /*
   2  * Copyright (c) 2022 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.binding;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import edu.umd.cs.findbugs.annotations.CheckReturnValue;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.common.RpcResult;
  14
  15 /**
  16  * Interface extended by all interfaces generated for a YANG {@code rpc}.
  17  */
  18 public non-sealed interface Rpc<I extends RpcInput, O extends RpcOutput> extends BindingContract<Rpc<I, O>> {
  19     /**
  20      * Invoke the RPC.
  21      *
  22      * @param input Input argument
  23      * @return Future result of invocation
  24      * @throws NullPointerException if any of the arguments are null
  25      */
  26     @CheckReturnValue
  27     @NonNull ListenableFuture<@NonNull RpcResult<@NonNull O>> invoke(@NonNull I input);
  28 }