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.flowprogrammer.Flow;
19 * Interface for retrieving the network node's flow/port/queue hardware view
24 public interface IReadService {
26 * Get the hardware view for the specified flow on the specified network node
31 FlowOnNode readFlow(Node node, Flow flow);
34 * Get the hardware view for the specified flow on the specified network node
35 * This call results in a direct polling of the information from the node
36 * Caller will be blocked until node replies or request times out
41 FlowOnNode nonCachedReadFlow(Node node, Flow flow);
44 * Get the hardware view for all the flows installed on the network node
49 List<FlowOnNode> readAllFlows(Node node);
52 * Get the hardware view for all the flows installed on the network node
53 * This call results in a direct polling of the information from the node
54 * Caller will be blocked until node replies or request times out
59 List<FlowOnNode> nonCachedReadAllFlows(Node node);
62 * Get the description information for the network node
66 NodeDescription readDescription(Node node);
69 * Get the description information for the network node
70 * This call results in a direct polling of the information from the node
71 * Caller will be blocked until node replies or request times out
76 NodeDescription nonCachedReadDescription(Node node);
79 * Get the hardware view for the specified node connector
82 NodeConnectorStatistics readNodeConnector(NodeConnector connector);
85 * Get the hardware view for all the node connectors
86 * present on the specified network node
89 List<NodeConnectorStatistics> readNodeConnectors(Node node);
92 * Get the node connectors statistics information for the network node
93 * This call results in a direct polling of the information from the node
94 * Caller will be blocked until node replies or request times out
99 List<NodeConnectorStatistics> nonCachedReadNodeConnectors(Node node);
102 * Get the node connectors statistics information for the network node
107 NodeConnectorStatistics nonCachedReadNodeConnector(NodeConnector connector);
110 * Get the transmit rate for the specified node connector
113 * @return tx rate [bps]
115 long getTransmitRate(NodeConnector connector);