org.onosproject.ui.impl.topo.util

Class TrafficLink

java.lang.Object

org.onosproject.ui.topo.BiLink

org.onosproject.ui.impl.topo.util.TrafficLink

public class TrafficLink
extends org.onosproject.ui.topo.BiLink

Representation of a link and its inverse, and associated traffic data. This class understands how to generate the appropriate LinkHighlights for showing traffic data on the topology view.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrafficLink.StatsType Designates type of traffic statistics to report on a highlighted link.

Constructor Summary

Constructors

Constructor and Description
TrafficLink(org.onosproject.net.LinkKey key, org.onosproject.net.Link link) Constructs a traffic link for the given key and initial link.

Method Summary

Modifier and Type	Method and Description
void	addFlows(int count) Adds the given count of flows to this traffic link.
void	addLoad(org.onosproject.net.statistic.Load load) Adds load statistics, marks the traffic link as having traffic.
void	addLoad(org.onosproject.net.statistic.Load load, double threshold) Adds load statistics, marks the traffic link as having traffic, if the load rate is greater than the given threshold (expressed in bytes per second).
TrafficLink	antMarch(boolean b) Sets the ant march flag to the given value.
boolean	hasTraffic() Returns true if this link has been deemed to have enough traffic to register on the topology view in the web UI.
org.onosproject.ui.topo.LinkHighlight	highlight(Enum<?> type)
TrafficLink	optical(boolean b) Sets the optical flag to the given value.
TrafficLink	tagFlavor(org.onosproject.ui.topo.LinkHighlight.Flavor flavor) Tags this traffic link with the flavor to be used in visual rendering.

Methods inherited from class org.onosproject.ui.topo.BiLink

key, linkId, one, setOther, two

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrafficLink

public TrafficLink(org.onosproject.net.LinkKey key,
                   org.onosproject.net.Link link)

Constructs a traffic link for the given key and initial link.

Parameters:

key - canonical key for this traffic link

link - first link

Method Detail

optical

public TrafficLink optical(boolean b)

Sets the optical flag to the given value.

Parameters:

b - true if an optical link

Returns:

self, for chaining

antMarch

public TrafficLink antMarch(boolean b)

Sets the ant march flag to the given value.

Parameters:

b - true if marching ants required

Returns:

self, for chaining

tagFlavor

public TrafficLink tagFlavor(org.onosproject.ui.topo.LinkHighlight.Flavor flavor)

Tags this traffic link with the flavor to be used in visual rendering.

Parameters:

flavor - the flavor to tag

Returns:

self, for chaining

addLoad

public void addLoad(org.onosproject.net.statistic.Load load)

Adds load statistics, marks the traffic link as having traffic.

Parameters:

load - load to add

addLoad

public void addLoad(org.onosproject.net.statistic.Load load,
                    double threshold)

Adds load statistics, marks the traffic link as having traffic, if the load rate is greater than the given threshold (expressed in bytes per second).

Parameters:

load - load to add

threshold - threshold to register traffic

addFlows

public void addFlows(int count)

Adds the given count of flows to this traffic link.

Parameters:

count - count of flows

highlight

public org.onosproject.ui.topo.LinkHighlight highlight(Enum<?> type)

Specified by:

highlight in class org.onosproject.ui.topo.BiLink

hasTraffic

public boolean hasTraffic()

Returns true if this link has been deemed to have enough traffic to register on the topology view in the web UI.

Returns:

true if this link has displayable traffic