diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java')
-rw-r--r-- | framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java b/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java new file mode 100644 index 00000000..02052c37 --- /dev/null +++ b/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/resource/label/LabelResourceService.java @@ -0,0 +1,100 @@ +package org.onosproject.incubator.net.resource.label; + +import java.util.Collection; +import java.util.Set; + +import com.google.common.annotations.Beta; +import org.onosproject.event.ListenerService; +import org.onosproject.net.DeviceId; + +import com.google.common.collect.Multimap; + +/** + * Service for providing label resource allocation. + */ +@Beta +public interface LabelResourceService + extends ListenerService<LabelResourceEvent, LabelResourceListener> { + + /** + * Returns labels from resource pool by a specific device id. + * + * @param deviceId device identifier + * @param applyNum the applying number + * @return collection of applying labels + */ + Collection<LabelResource> applyFromDevicePool(DeviceId deviceId, + long applyNum); + + /** + * Returns labels from the global label resource pool. + * + * @param applyNum the applying number + * @return collection of applying labels + */ + Collection<LabelResource> applyFromGlobalPool(long applyNum); + + /** + * Releases unused labels to device pools . + * + * @param release the collection of releasing labels + * @return success or fail + */ + boolean releaseToDevicePool(Multimap<DeviceId, LabelResource> release); + + /** + * Releases unused labels to the global resource pool. + * + * @param release release the collection of releasing labels + * @return success or fail + */ + boolean releaseToGlobalPool(Set<LabelResourceId> release); + + /** + * Judges if the pool of a specific device id is full. + * + * @param deviceId device identifier + * @return yes or no + */ + boolean isDevicePoolFull(DeviceId deviceId); + + /** + * Judges if the global resource pool is full. + * + * @return yes or no + */ + boolean isGlobalPoolFull(); + + /** + * Returns the unused label number of a label resource pool by a specific device + * id. + * + * @param deviceId device identifier + * @return number of unused labels + */ + long getFreeNumOfDevicePool(DeviceId deviceId); + + /** + * Returns the unused label number of a global label resource pool. + * + * @return number of unused labels + */ + long getFreeNumOfGlobalPool(); + + /** + * Returns the label resource pool of a label resource by a specific device + * id. + * + * @param deviceId device identifier + * @return the device label resource pool + */ + LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId); + + /** + * Returns the global label resource pool. + * + * @return the global label resource pool + */ + LabelResourcePool getGlobalLabelResourcePool(); + +} |