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.flowprogrammer.Flow;
17 import org.opendaylight.controller.sal.reader.FlowOnNode;
18 import org.opendaylight.controller.sal.reader.NodeConnectorStatistics;
19 import org.opendaylight.controller.sal.reader.NodeDescription;
22 * Interface to serve the hardware information requests coming from SAL
23 * It is implemented by the respective OF1.0 plugin component
26 public interface IPluginReadServiceFilter {
28 * Returns the hardware image for the specified flow
29 * on the specified network node for the passed container
37 public FlowOnNode readFlow(String container, Node node, Flow flow,
41 * Returns the hardware view of all the flow installed
42 * on the specified network node for the passed container
49 public List<FlowOnNode> readAllFlow(String container, Node node,
53 * Returns the description of the network node as provided by the node itself
59 public NodeDescription readDescription(Node node, boolean cached);
62 * Returns the hardware view of the specified network node connector
63 * for the given container
67 public NodeConnectorStatistics readNodeConnector(String container,
68 NodeConnector nodeConnector, boolean cached);
71 * Returns the hardware info for all the node connectors on the
72 * specified network node for the given container
77 public List<NodeConnectorStatistics> readAllNodeConnector(String container,
78 Node node, boolean cached);
81 * Returns the average transmit rate for the specified node conenctor on
82 * the given container. If the node connector does not belong to the passed
83 * container a zero value is returned
86 * @param nodeConnector
87 * @return tx rate [bps]
89 public long getTransmitRate(String container, NodeConnector nodeConnector);