openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/rpc/RpcContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.openflowplugin.api.openflow.rpc;
   9
  10 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  11 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  12 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
  13 import org.opendaylight.yangtools.yang.binding.RpcService;
  14
  15 /**
  16  * This context is registered with MD-SAL as a routed RPC provider for the inventory node backed by this switch and
  17  * tracks the state of any user requests and how they map onto protocol requests. It uses
  18  * {@link org.opendaylight.openflowplugin.api.openflow.device.RequestContext} to perform requests.
  19  * <p>
  20  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  21  */
  22 public interface RpcContext extends RequestContextStack, AutoCloseable, DeviceDisconnectedHandler {
  23
  24     <S extends RpcService> void registerRpcServiceImplementation(Class<S> serviceClass, S serviceInstance);
  25
  26
  27     /**
  28      * Method for setting request quota value. When the Request Context quota is exceeded, incoming RPCs fail
  29      * immediately, with a well-defined error.
  30      *
  31      * @param maxRequestsPerDevice
  32      */
  33     void setRequestContextQuota(int maxRequestsPerDevice);
  34
  35 }