org.opendaylight.controller.statisticsmanager

Interface IStatisticsManager

public interface IStatisticsManager

Interface which defines the available methods for retrieving the network nodes statistics.

Method Summary

Methods

Modifier and Type	Method and Description
List<org.opendaylight.controller.sal.reader.FlowOnNode>	getFlows(org.opendaylight.controller.sal.core.Node node) Return all the statistics for all the flows present on the specified node in the current container context.
List<org.opendaylight.controller.sal.reader.FlowOnNode>	getFlowsNoCache(org.opendaylight.controller.sal.core.Node node) Same as the getFlows method.
int	getFlowsNumber(org.opendaylight.controller.sal.core.Node node) Returns the number of flows installed on the switch in the current container context If the context is the default container, the returned value is the number of all the flows installed on the switch regardless of the container they belong to
Map<org.opendaylight.controller.sal.core.Node,List<org.opendaylight.controller.sal.reader.FlowOnNode>>	getFlowStatisticsForFlowList(List<org.opendaylight.controller.forwardingrulesmanager.FlowEntry> flows) Returns the statistics for the flows specified in the list
List<org.opendaylight.controller.sal.reader.NodeConnectorStatistics>	getNodeConnectorStatistics(org.opendaylight.controller.sal.core.Node node) Returns the statistics for all the node connector present on the specified network node
org.opendaylight.controller.sal.reader.NodeConnectorStatistics	getNodeConnectorStatistics(org.opendaylight.controller.sal.core.NodeConnector nodeConnector) Returns the statistics for the specified node connector as it was retrieved by the protocol plugin component and cached by statistics manager.
org.opendaylight.controller.sal.reader.NodeDescription	getNodeDescription(org.opendaylight.controller.sal.core.Node node) Returns the node description for the specified node retrieved by the protocol plugin component and cached by statistics manager.
List<org.opendaylight.controller.sal.reader.NodeTableStatistics>	getNodeTableStatistics(org.opendaylight.controller.sal.core.Node node) Returns the statistics for all the tables of the node
org.opendaylight.controller.sal.reader.NodeTableStatistics	getNodeTableStatistics(org.opendaylight.controller.sal.core.NodeTable nodeTable) Returns the statistics for the specified table of the node

Method Detail

getFlows

List<org.opendaylight.controller.sal.reader.FlowOnNode> getFlows(org.opendaylight.controller.sal.core.Node node)

Return all the statistics for all the flows present on the specified node in the current container context. If the context is the default container, the returned statistics are for all the flows installed on the node, regardless of the container they belong to

Parameters:

node - The network node

Returns:

List of flows installed on the network node. Null if specified node is null. Empty list if node/stat is not present.

getFlowsNoCache

List<org.opendaylight.controller.sal.reader.FlowOnNode> getFlowsNoCache(org.opendaylight.controller.sal.core.Node node)

Same as the getFlows method. The only difference is that this method does not return cached flows. It will always make a request to the node to get all the flows for that node. If the request times out or gets an error, we revert to getting the cached flows.

Parameters:

node -

Returns:

List of flows installed on the network node.

See Also:

getFlows(org.opendaylight.controller.sal.core.Node)

getFlowStatisticsForFlowList

Map<org.opendaylight.controller.sal.core.Node,List<org.opendaylight.controller.sal.reader.FlowOnNode>> getFlowStatisticsForFlowList(List<org.opendaylight.controller.forwardingrulesmanager.FlowEntry> flows)

Returns the statistics for the flows specified in the list

Parameters:

flows -

Returns:

A map of flows per node installed on that node, empty map if flows is null/empty.

getFlowsNumber

int getFlowsNumber(org.opendaylight.controller.sal.core.Node node)

Returns the number of flows installed on the switch in the current container context If the context is the default container, the returned value is the number of all the flows installed on the switch regardless of the container they belong to

Parameters:

node -

Returns:

number of flows on specified node or (-1) if node was not found

getNodeDescription

org.opendaylight.controller.sal.reader.NodeDescription getNodeDescription(org.opendaylight.controller.sal.core.Node node)

Returns the node description for the specified node retrieved by the protocol plugin component and cached by statistics manager. Null if node not found.

Parameters:

node -

Returns:

node description

getNodeConnectorStatistics

org.opendaylight.controller.sal.reader.NodeConnectorStatistics getNodeConnectorStatistics(org.opendaylight.controller.sal.core.NodeConnector nodeConnector)

Returns the statistics for the specified node connector as it was retrieved by the protocol plugin component and cached by statistics manager.

Parameters:

node -

Returns:

Node connector statistics or null if requested stats was not found.

getNodeConnectorStatistics

List<org.opendaylight.controller.sal.reader.NodeConnectorStatistics> getNodeConnectorStatistics(org.opendaylight.controller.sal.core.Node node)

Returns the statistics for all the node connector present on the specified network node

Parameters:

node -

Returns:

List of node connector statistics. Null if node is null. Empty list if node/stats is not present.

getNodeTableStatistics

org.opendaylight.controller.sal.reader.NodeTableStatistics getNodeTableStatistics(org.opendaylight.controller.sal.core.NodeTable nodeTable)

Returns the statistics for the specified table of the node

Parameters:

nodeTable -

Returns:

Table statistics. Null if node table is null or stats not found.

getNodeTableStatistics

List<org.opendaylight.controller.sal.reader.NodeTableStatistics> getNodeTableStatistics(org.opendaylight.controller.sal.core.Node node)

Returns the statistics for all the tables of the node

Parameters:

nodeTable -

Returns:

List of table stats. Null if node is null. Empty list if node/stats not found.