Package org.onosproject.net.link
Interface LinkStore
- 
- All Superinterfaces:
- Store<LinkEvent,LinkStoreDelegate>
 
 public interface LinkStore extends Store<LinkEvent,LinkStoreDelegate> Manages inventory of infrastructure links; not intended for direct use.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description LinkEventcreateOrUpdateLink(ProviderId providerId, LinkDescription linkDescription)Creates a new link, or updates an existing one, based on the given information.java.util.Set<Link>getDeviceEgressLinks(DeviceId deviceId)Returns all links egressing from the specified device.java.util.Set<Link>getDeviceIngressLinks(DeviceId deviceId)Returns all links ingressing from the specified device.java.util.Set<Link>getEgressLinks(ConnectPoint src)Returns all links egressing from the specified connection point.java.util.Set<Link>getIngressLinks(ConnectPoint dst)Returns all links ingressing to the specified connection point.LinkgetLink(ConnectPoint src, ConnectPoint dst)Returns the link between the two end-points.intgetLinkCount()Returns the number of links in the store.java.lang.Iterable<Link>getLinks()Returns an iterable collection of all links in the inventory.LinkEventremoveLink(ConnectPoint src, ConnectPoint dst)Removes the link based on the specified information.LinkEventremoveOrDownLink(ConnectPoint src, ConnectPoint dst)Removes the link, or marks it as inactive if the link is durable, based on the specified information.- 
Methods inherited from interface org.onosproject.store.StorehasDelegate, setDelegate, unsetDelegate
 
- 
 
- 
- 
- 
Method Detail- 
getLinkCountint getLinkCount() Returns the number of links in the store.- Returns:
- number of links
 
 - 
getLinksjava.lang.Iterable<Link> getLinks() Returns an iterable collection of all links in the inventory.- Returns:
- collection of all links
 
 - 
getDeviceEgressLinksjava.util.Set<Link> getDeviceEgressLinks(DeviceId deviceId) Returns all links egressing from the specified device.- Parameters:
- deviceId- device identifier
- Returns:
- set of device links
 
 - 
getDeviceIngressLinksjava.util.Set<Link> getDeviceIngressLinks(DeviceId deviceId) Returns all links ingressing from the specified device.- Parameters:
- deviceId- device identifier
- Returns:
- set of device links
 
 - 
getLinkLink getLink(ConnectPoint src, ConnectPoint dst) Returns the link between the two end-points.- Parameters:
- src- source connection point
- dst- destination connection point
- Returns:
- link or null if one not found between the end-points
 
 - 
getEgressLinksjava.util.Set<Link> getEgressLinks(ConnectPoint src) Returns all links egressing from the specified connection point.- Parameters:
- src- source connection point
- Returns:
- set of connection point links
 
 - 
getIngressLinksjava.util.Set<Link> getIngressLinks(ConnectPoint dst) Returns all links ingressing to the specified connection point.- Parameters:
- dst- destination connection point
- Returns:
- set of connection point links
 
 - 
createOrUpdateLinkLinkEvent createOrUpdateLink(ProviderId providerId, LinkDescription linkDescription) Creates a new link, or updates an existing one, based on the given information.- Parameters:
- providerId- provider identity
- linkDescription- link description
- Returns:
- create or update link event, or null if no change resulted
 
 - 
removeOrDownLinkLinkEvent removeOrDownLink(ConnectPoint src, ConnectPoint dst) Removes the link, or marks it as inactive if the link is durable, based on the specified information.- Parameters:
- src- link source
- dst- link destination
- Returns:
- remove or update link event, or null if no change resulted
 
 - 
removeLinkLinkEvent removeLink(ConnectPoint src, ConnectPoint dst) Removes the link based on the specified information.- Parameters:
- src- link source
- dst- link destination
- Returns:
- remove link event, or null if no change resulted
 
 
- 
 
-