com.hp.sdn.tvue

Interface TopologyViewerService

public interface TopologyViewerService

TopologyViewer service interface

Author:

Thomas Vachuska, Anuradha Musunuri

Method Summary

Methods

Modifier and Type	Method and Description
List<MBodyFlowStats>	getFlowStats(DataPathId dpid) Returns list of switch flow stats.
Set<Link>	getLinks() Returns all links.
NetworkElement	getNode(ElementId elementId) Returns the node with the specified id.
NetworkElement	getNode(String id) Returns the node with the specified String id.
Set<NetworkElement>	getNodes() Returns all nodes and devices.
BigPortNumber	getOutPort(MBodyFlowStats rule) Gets the outPort for a given flow stats
Path	getPath(NetworkElement src, NetworkElement dst) Returns the shortest path between the specified nodes.
Path	getPathFollowingFlows(NetworkElement src, NetworkElement dst, EthernetType ethType, IpProtocol protocol) Returns the path between the specified nodes using the supplied flow descriptors.
String	getPathLinkAnnotation(Link link) Provides packetCount and bytecount for a path link when follow flow is selected
long	lastModified() Returns the time-stamp of the most recent modification of the node or link data.
void	resetCache() Resets the node cache and reloads it from scratch.

Method Detail

lastModified

long lastModified()

Returns the time-stamp of the most recent modification of the node or link data.

Returns:

time-stamp in milliseconds since start of epoch

getNodes

Set<NetworkElement> getNodes()

Returns all nodes and devices.

Returns:

set of all nodes and devices

getLinks

Set<Link> getLinks()

Returns all links.

Returns:

set of all links

getNode

NetworkElement getNode(ElementId elementId)

Returns the node with the specified id.

Parameters:

elementId - element id (node/device)

Returns:

element with given id; null if none found

getNode

NetworkElement getNode(String id)

Returns the node with the specified String id.

Parameters:

id - Mac Address for nodes/Dpid for devices

Returns:

Network element object with given id; null if none found

getPath

Path getPath(NetworkElement src,
           NetworkElement dst)

Returns the shortest path between the specified nodes.

Parameters:

src - source element (Node/Device)

dst - destination (Node/Device)

Returns:

path descriptor

getPathFollowingFlows

Path getPathFollowingFlows(NetworkElement src,
                         NetworkElement dst,
                         EthernetType ethType,
                         IpProtocol protocol)

Returns the path between the specified nodes using the supplied flow descriptors.

Parameters:

src - source Node (cannot be a device)

dst - destination Node (cannot be a device)

ethType - Ethernet Type

protocol - IP protocol number

Returns:

path descriptor

Throws:

IllegalArgumentException - if either of the srcId or dstId are device Ids

getFlowStats

List<MBodyFlowStats> getFlowStats(DataPathId dpid)

Returns list of switch flow stats.

Parameters:

dpid - switch datapath id

Returns:

list of flow stat descriptors

getOutPort

BigPortNumber getOutPort(MBodyFlowStats rule)

Gets the outPort for a given flow stats

Parameters:

rule - flow stats

Returns:

outPort of the flow

getPathLinkAnnotation

String getPathLinkAnnotation(Link link)

Provides packetCount and bytecount for a path link when follow flow is selected

Parameters:

link - link to get the stats for

Returns:

annotation that contains packetcount and bytecount

resetCache

void resetCache()

Resets the node cache and reloads it from scratch.