3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
10 package org.opendaylight.controller.sal.reader;
12 import java.util.List;
14 import org.opendaylight.controller.sal.core.Node;
15 import org.opendaylight.controller.sal.core.NodeConnector;
16 import org.opendaylight.controller.sal.core.NodeTable;
17 import org.opendaylight.controller.sal.flowprogrammer.Flow;
20 * @file IPluginInReadService.java
22 * @brief Hardware view interface to be implemented by protocol plugins
27 public interface IPluginInReadService {
30 * Returns the hardware image for the specified flow on the specified network node
35 public FlowOnNode readFlow(Node node, Flow flow, boolean cached);
38 * Returns the hardware view of all the flow installed on the specified network node
42 public List<FlowOnNode> readAllFlow(Node node, boolean cached);
45 * Returns the description of the network node as provided by the node itself
49 public NodeDescription readDescription(Node node, boolean cached);
52 * Returns the hardware view of the specified network node connector
56 public NodeConnectorStatistics readNodeConnector(NodeConnector connector,
60 * Returns the hardware info for all the node connectors on the specified network node
64 public List<NodeConnectorStatistics> readAllNodeConnector(Node node,
68 * Returns the table statistics for the node
72 public NodeTableStatistics readNodeTable(NodeTable table, boolean cached);
75 * Returns all the table statistics for the node
79 public List<NodeTableStatistics> readAllNodeTable(Node node, boolean cached);
82 * Returns the averaged transmit rate for the specified node connector
84 * @return tx rate [bps]
86 public long getTransmitRate(NodeConnector connector);