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.protocol_plugin.openflow;
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;
18 import org.opendaylight.controller.sal.reader.FlowOnNode;
19 import org.opendaylight.controller.sal.reader.NodeConnectorStatistics;
20 import org.opendaylight.controller.sal.reader.NodeDescription;
21 import org.opendaylight.controller.sal.reader.NodeTableStatistics;
24 * Interface to serve the hardware information requests coming from SAL
25 * It is implemented by the respective OF1.0 plugin component
28 public interface IReadServiceFilter {
30 * Returns the hardware image for the specified flow
31 * on the specified network node for the passed container
39 public FlowOnNode readFlow(String container, Node node, Flow flow,
43 * Returns the hardware view of all the flow installed
44 * on the specified network node for the passed container
51 public List<FlowOnNode> readAllFlow(String container, Node node,
55 * Returns the description of the network node as provided by the node itself
61 public NodeDescription readDescription(Node node, boolean cached);
64 * Returns the hardware view of the specified network node connector
65 * for the given container
69 public NodeConnectorStatistics readNodeConnector(String container,
70 NodeConnector nodeConnector, boolean cached);
73 * Returns the hardware info for all the node connectors on the
74 * specified network node for the given container
79 public List<NodeConnectorStatistics> readAllNodeConnector(String container,
80 Node node, boolean cached);
83 * Returns the table statistics of the node as specified by the given container
88 public NodeTableStatistics readNodeTable(String container,
89 NodeTable nodeTable, boolean cached);
92 * Returns the table statistics of all the tables for the specified node
97 public List<NodeTableStatistics> readAllNodeTable(String containerName,
98 Node node, boolean cached);
101 * Returns the average transmit rate for the specified node conenctor on
102 * the given container. If the node connector does not belong to the passed
103 * container a zero value is returned
106 * @param nodeConnector
107 * @return tx rate [bps]
109 public long getTransmitRate(String container, NodeConnector nodeConnector);