com.hp.sdn.topo

Interface TopologyData

public interface TopologyData

Carrier of processed topology data used for serving out paths, broadcast trees, etc.

Author:

Thomas Vachuska

Method Summary

Methods

Modifier and Type	Method and Description
Map<Vertex,Set<Edge>>	broadcastPoints(DeviceId deviceId) For a given Device Id, get a map of devices and links on which a packet can be broadcast from the given deviceId.
Set<DeviceId>	clusterDevices(TopologyCluster cluster) Returns the set of devices that belong to the cluster.
TopologyCluster	clusterFor(DeviceId deviceId) Returns the topology cluster data containing the specified device.
Set<Link>	clusterLinks(TopologyCluster cluster) Returns the set of links that belong to the cluster.
Set<TopologyCluster>	clusters() Returns the set of connectivity clusters.
Set<Path>	getPaths(DeviceId src, DeviceId dst) Returns the paths from the given source vertex to a given destination vertex.
Set<Path>	getPaths(DeviceId src, DeviceId dst, LinkWeight weight) Get the set of shortest paths computed using the supplied edge weight.
Graph	graph() Returns the graph model of the network.
long	ts() Returns the timestamp (in nanos) of when the topology data was generated.

Method Detail

ts

long ts()

Returns the timestamp (in nanos) of when the topology data was generated.

Returns:

timestamp of the topology data

graph

Graph graph()

Returns the graph model of the network. The vertexes are assumed to be derivatives of TopoVertex and edges derivatives of TopoEdge classes.

Returns:

network graph

getPaths

Set<Path> getPaths(DeviceId src,
                 DeviceId dst)

Returns the paths from the given source vertex to a given destination vertex.

Parameters:

src - source device id

dst - destination device id

Returns:

set of paths

getPaths

Set<Path> getPaths(DeviceId src,
                 DeviceId dst,
                 LinkWeight weight)

Get the set of shortest paths computed using the supplied edge weight.

Parameters:

src - path source

dst - path destination

weight - link edge weight

Returns:

set of shortest paths between the src/dst pair

broadcastPoints

Map<Vertex,Set<Edge>> broadcastPoints(DeviceId deviceId)

For a given Device Id, get a map of devices and links on which a packet can be broadcast from the given deviceId.

Parameters:

deviceId - source device id

Returns:

map of broadcast points

clusters

Set<TopologyCluster> clusters()

Returns the set of connectivity clusters.

Returns:

set of topology clusters

clusterFor

TopologyCluster clusterFor(DeviceId deviceId)

Returns the topology cluster data containing the specified device.

Parameters:

deviceId - source device id

Returns:

topology cluster data

clusterDevices

Set<DeviceId> clusterDevices(TopologyCluster cluster)

Returns the set of devices that belong to the cluster.

Parameters:

cluster - to inspect

Returns:

set of cluster devices

clusterLinks

Set<Link> clusterLinks(TopologyCluster cluster)

Returns the set of links that belong to the cluster.

Parameters:

cluster - to inspect

Returns:

set of cluster links