org.onosproject.ui.impl

Class TrafficMonitor

java.lang.Object

org.onosproject.ui.impl.TrafficMonitor

public class TrafficMonitor
extends Object

Encapsulates the behavior of monitoring specific traffic patterns.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrafficMonitor.Mode Designates the different modes of operation.

Constructor Summary

Constructors

Constructor and Description
TrafficMonitor(long trafficPeriod, ServicesBundle servicesBundle, TopologyViewMessageHandler msgHandler) Constructs a traffic monitor.

Method Summary

Modifier and Type	Method and Description
void	monitor(org.onosproject.net.intent.Intent intent) Monitor for traffic data to be sent back to the web client, for the given intent.
void	monitor(TrafficMonitor.Mode mode) Monitor for traffic data to be sent back to the web client, under the given mode.
void	monitor(TrafficMonitor.Mode mode, org.onosproject.ui.topo.NodeSelection nodeSelection) Monitor for traffic data to be sent back to the web client, under the given mode, using the given selection of devices and hosts.
void	pokeIntent() Resends selected intent traffic data.
void	selectNextIntent() Selects the next intent in the select group (if there is one), and sends highlighting data back to the web client to display which path is selected.
void	selectPreviousIntent() Selects the previous intent in the select group (if there is one), and sends highlighting data back to the web client to display which path is selected.
void	stopMonitoring() Stop all traffic monitoring.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficMonitor

public TrafficMonitor(long trafficPeriod,
                      ServicesBundle servicesBundle,
                      TopologyViewMessageHandler msgHandler)

Constructs a traffic monitor.

Parameters:

trafficPeriod - traffic task period in ms

servicesBundle - bundle of services

msgHandler - our message handler

Method Detail

monitor

public void monitor(TrafficMonitor.Mode mode)

Monitor for traffic data to be sent back to the web client, under the given mode. This causes a background traffic task to be scheduled to repeatedly compute and transmit the appropriate traffic data to the client.

The monitoring mode is expected to be one of:

• ALL_FLOW_TRAFFIC
• ALL_PORT_TRAFFIC
• SELECTED_INTENT

Parameters:

mode - monitoring mode

monitor

public void monitor(TrafficMonitor.Mode mode,
                    org.onosproject.ui.topo.NodeSelection nodeSelection)

Monitor for traffic data to be sent back to the web client, under the given mode, using the given selection of devices and hosts. In the case of "device link flows", this causes a background traffic task to be scheduled to repeatedly compute and transmit the appropriate traffic data to the client. In the case of "related intents", no repeating task is scheduled.

The monitoring mode is expected to be one of:

• DEV_LINK_FLOWS
• RELATED_INTENTS

Parameters:

mode - monitoring mode

nodeSelection - how to select a node

monitor

public void monitor(org.onosproject.net.intent.Intent intent)

Monitor for traffic data to be sent back to the web client, for the given intent.

Parameters:

intent - the intent to monitor

selectNextIntent

public void selectNextIntent()

Selects the next intent in the select group (if there is one), and sends highlighting data back to the web client to display which path is selected.

selectPreviousIntent

public void selectPreviousIntent()

Selects the previous intent in the select group (if there is one), and sends highlighting data back to the web client to display which path is selected.

pokeIntent

public void pokeIntent()

Resends selected intent traffic data. This is called, for example, when the system detects an intent update happened.

stopMonitoring

public void stopMonitoring()

Stop all traffic monitoring.