Package org.onosproject.net.link

Interface LinkService

All Superinterfaces:

ListenerService<LinkEvent,LinkListener>

All Known Subinterfaces:

LinkAdminService

public interface LinkService
extends ListenerService<LinkEvent,LinkListener>

Service for interacting with the inventory of infrastructure links.

Method Summary

Modifier and Type	Method	Description
java.lang.Iterable<Link>	getActiveLinks()	Returns a collection of all active infrastructure links.
java.util.Set<Link>	getDeviceEgressLinks(DeviceId deviceId)	Returns set of all infrastructure links leading from the specified device.
java.util.Set<Link>	getDeviceIngressLinks(DeviceId deviceId)	Returns set of all infrastructure links leading to the specified device.
java.util.Set<Link>	getDeviceLinks(DeviceId deviceId)	Returns set of all infrastructure links leading to and from the specified device.
java.util.Set<Link>	getEgressLinks(ConnectPoint connectPoint)	Returns set of all infrastructure links leading from the specified connection point.
java.util.Set<Link>	getIngressLinks(ConnectPoint connectPoint)	Returns set of all infrastructure links leading to the specified connection point.
Link	getLink(ConnectPoint src, ConnectPoint dst)	Returns the infrastructure links between the specified source and destination connection points.
int	getLinkCount()	Returns the count of all known infrastructure links.
java.lang.Iterable<Link>	getLinks()	Returns a collection of all known infrastructure links.
java.util.Set<Link>	getLinks(ConnectPoint connectPoint)	Returns set of all infrastructure links leading to and from the specified connection point.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

getLinkCount

int getLinkCount()

Returns the count of all known infrastructure links.

Returns:

number of infrastructure links

getLinks

java.lang.Iterable<Link> getLinks()

Returns a collection of all known infrastructure links.

Returns:

all infrastructure links

getActiveLinks

java.lang.Iterable<Link> getActiveLinks()

Returns a collection of all active infrastructure links.

Returns:

all infrastructure links

getDeviceLinks

java.util.Set<Link> getDeviceLinks(DeviceId deviceId)

Returns set of all infrastructure links leading to and from the specified device.

Parameters:

deviceId - device identifier

Returns:

set of device links

getDeviceEgressLinks

java.util.Set<Link> getDeviceEgressLinks(DeviceId deviceId)

Returns set of all infrastructure links leading from the specified device.

Parameters:

deviceId - device identifier

Returns:

set of device egress links

getDeviceIngressLinks

java.util.Set<Link> getDeviceIngressLinks(DeviceId deviceId)

Returns set of all infrastructure links leading to the specified device.

Parameters:

deviceId - device identifier

Returns:

set of device ingress links

getLinks

java.util.Set<Link> getLinks(ConnectPoint connectPoint)

Returns set of all infrastructure links leading to and from the specified connection point.

Parameters:

connectPoint - connection point

Returns:

set of links

getEgressLinks

java.util.Set<Link> getEgressLinks(ConnectPoint connectPoint)

Returns set of all infrastructure links leading from the specified connection point.

Parameters:

connectPoint - connection point

Returns:

set of device egress links

getIngressLinks

java.util.Set<Link> getIngressLinks(ConnectPoint connectPoint)

Returns set of all infrastructure links leading to the specified connection point.

Parameters:

connectPoint - connection point

Returns:

set of device ingress links

getLink

Link getLink(ConnectPoint src,
             ConnectPoint dst)

Returns the infrastructure links between the specified source and destination connection points.

Parameters:

src - source connection point

dst - destination connection point

Returns:

link from source to destination; null if none found