be.ac.ulg.montefiore.run.totem.repository.model
Interface SPF

All Known Implementing Classes:

Bhandari, CSPF, CSPFHopCount, CSPFInvCap, CSPFInvFreeBw, CSPFTEMetric

public interface SPF

This interface describes the Shortest Path First service.

Creation date: 25-May-2004

Author:

Fabian Skivee (skivee@run.montefiore.ulg.ac.be)

Method Summary

java.util.List<Path>	computeFullMeshSPF(Domain domain) Computes a unique shortest path between all nodes in the topology
java.util.List<Path>	computeFullMeshSPF(Domain domain, boolean ECMP) Computes the shortest paths between all nodes in the topology
java.util.List<Path>	computeSPF(Domain domain, boolean isSource, java.lang.String node) Computes a unique shortest path from (resp.
java.util.List<Path>	computeSPF(Domain domain, boolean isSource, java.lang.String node, boolean ECMP) Computes the shortest paths from (resp.
java.util.List<Path>	computeSPF(Domain domain, java.lang.String src) Computes a unique shortest path from a source node to all destination node
java.util.List<Path>	computeSPF(Domain domain, java.lang.String src, boolean ECMP) Computes the shortest paths from a source node to all destination node
Path	computeSPF(Domain domain, java.lang.String src, java.lang.String dst) Computes a unique shortest path between two nodes
java.util.List<Path>	computeSPF(Domain domain, java.lang.String src, java.lang.String dst, boolean ECMP) Computes the shortest path between two nodes.
boolean	equals(java.lang.Object o)
int	hashCode()

Method Detail

computeSPF

Path computeSPF(Domain domain,
                java.lang.String src,
                java.lang.String dst)
                throws RoutingException,
                       NoRouteToHostException

Computes a unique shortest path between two nodes

Parameters:

domain -

src - the source node

dst - the destination node

Returns:

a Path

Throws:

RoutingException

NoRouteToHostException

computeSPF

java.util.List<Path> computeSPF(Domain domain,
                                java.lang.String src,
                                java.lang.String dst,
                                boolean ECMP)
                                throws RoutingException,
                                       NoRouteToHostException

Computes the shortest path between two nodes.

Parameters:

domain -

src - the source node

dst - the destination node

ECMP - true if multipath activated

Returns:

a list of equal cost multi path

Throws:

RoutingException

NoRouteToHostException

computeSPF

java.util.List<Path> computeSPF(Domain domain,
                                java.lang.String src)
                                throws RoutingException,
                                       NoRouteToHostException

Computes a unique shortest path from a source node to all destination node

Parameters:

domain -

src - the source node

Returns:

a list of N-1 (N = number of nodes) Path

Throws:

RoutingException

NoRouteToHostException

computeSPF

java.util.List<Path> computeSPF(Domain domain,
                                boolean isSource,
                                java.lang.String node)
                                throws RoutingException,
                                       NoRouteToHostException

Computes a unique shortest path from (resp. to) a node to (resp. from) all the other nodes depending on the value of isSource. If isSource is true, node is considered as the source node and the method computes a shortest path from this node to all the other nodes.

Parameters:

domain - The domain on which the paths have to be computed.

node - The source or destination node.

isSource - true if node is the source and false otherwise.

Returns:

The shortest paths from or to node.

Throws:

RoutingException

NoRouteToHostException

computeSPF

java.util.List<Path> computeSPF(Domain domain,
                                java.lang.String src,
                                boolean ECMP)
                                throws RoutingException,
                                       NoRouteToHostException

Computes the shortest paths from a source node to all destination node

Parameters:

domain -

src - the source node

ECMP - true if multipath is activated

Returns:

a list of N-1 (N = number of nodes) Path

Throws:

RoutingException

NoRouteToHostException

computeSPF

java.util.List<Path> computeSPF(Domain domain,
                                boolean isSource,
                                java.lang.String node,
                                boolean ECMP)
                                throws RoutingException,
                                       NoRouteToHostException

Computes the shortest paths from (resp. to) a node to (resp. from) all the other nodes depending on the value of isSource. If isSource is true, node is considered as the source node and the method computes a shortest path from this node to all the other nodes.

Parameters:

domain - The domain on which the paths have to be computed.

node - The source or destination node.

isSource - true if node is the source and false otherwise.

ECMP - true if multipath is activated

Returns:

The shortest paths from or to node.

Throws:

RoutingException

NoRouteToHostException

computeFullMeshSPF

java.util.List<Path> computeFullMeshSPF(Domain domain)
                                        throws RoutingException,
                                               NoRouteToHostException

Computes a unique shortest path between all nodes in the topology

Returns:

a list of N * N-1 Path (N = number of nodes)

Throws:

RoutingException

NoRouteToHostException

computeFullMeshSPF

java.util.List<Path> computeFullMeshSPF(Domain domain,
                                        boolean ECMP)
                                        throws RoutingException,
                                               NoRouteToHostException

Computes the shortest paths between all nodes in the topology

Parameters:

ECMP - true if multipath is activated

Returns:

a list of N * N-1 Path (N = number of nodes)

Throws:

RoutingException

NoRouteToHostException

equals

boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object