opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IPluginInReadService.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.sal.reader;
  11
  12 import java.util.List;
  13
  14 import org.opendaylight.controller.sal.core.Node;
  15 import org.opendaylight.controller.sal.core.NodeConnector;
  16 import org.opendaylight.controller.sal.flowprogrammer.Flow;
  17
  18 /**
  19  * @file   IPluginInReadService.java
  20  *
  21  * @brief  Hardware view interface to be implemented by protocol plugins
  22  *
  23  *
  24  *
  25  */
  26 public interface IPluginInReadService {
  27
  28     /**
  29      * Returns the hardware image for the specified flow on the specified network node
  30      * @param node
  31      * @param flow
  32      * @return
  33      */
  34     public FlowOnNode readFlow(Node node, Flow flow, boolean cached);
  35
  36     /**
  37      * Returns the hardware view of all the flow installed on the specified network node
  38      * @param node
  39      * @return
  40      */
  41     public List<FlowOnNode> readAllFlow(Node node, boolean cached);
  42
  43     /**
  44      * Returns the description of the network node as provided by the node itself
  45      * @param node
  46      * @return
  47      */
  48     public NodeDescription readDescription(Node node, boolean cached);
  49
  50     /**
  51      * Returns the hardware view of the specified network node connector
  52      * @param node
  53      * @return
  54      */
  55     public NodeConnectorStatistics readNodeConnector(NodeConnector connector,
  56             boolean cached);
  57
  58     /**
  59      * Returns the hardware info for all the node connectors on the specified network node
  60      * @param node
  61      * @return
  62      */
  63     public List<NodeConnectorStatistics> readAllNodeConnector(Node node,
  64             boolean cached);
  65
  66     /**
  67      * Returns the averaged transmit rate for the specified node connector
  68      * @param connector
  69      * @return tx rate [bps]
  70      */
  71     public long getTransmitRate(NodeConnector connector);
  72 }