mirrors/onos
1
0
Fork 0
mirror of https://github.com/opennetworkinglab/onos.git synced 2025-10-23 21:31:00 +02:00
Code Issues Projects Releases Wiki Activity

Add javadocs for LinkResourceStore interface.

Browse Source
This commit is contained in:
Toshio Koide 2014-10-30 10:54:25 -07:00
parent a4911315ea
commit 07df706db1
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
core/api/src/main/java/org/onlab/onos/net/resource/LinkResourceStore.java
View File

@ -20,20 +20,52 @@ import java.util.Set;
import org.onlab.onos.net.Link; import org.onlab.onos.net.Link;
import org.onlab.onos.net.intent.IntentId; import org.onlab.onos.net.intent.IntentId;
/** /**
* Manages link resources. * Manages link resources.
*/ */
public interface LinkResourceStore { public interface LinkResourceStore {
/**
* Returns free resources for given link.
*
* @param link a target link
* @return free resources for given link
*/
Set<ResourceAllocation> getFreeResources(Link link); Set<ResourceAllocation> getFreeResources(Link link);
/**
* Allocates resources.
*
* @param allocations resources to be allocated
*/
void allocateResources(LinkResourceAllocations allocations); void allocateResources(LinkResourceAllocations allocations);
/**
* Releases resources.
*
* @param allocations resources to be released
*/
void releaseResources(LinkResourceAllocations allocations); void releaseResources(LinkResourceAllocations allocations);
/**
* Returns resources allocated for an Intent.
*
* @param intentId the target Intent's ID
* @return allocated resources
*/
LinkResourceAllocations getAllocations(IntentId intentId); LinkResourceAllocations getAllocations(IntentId intentId);
/**
* Returns resources allocated for a link.
*
* @param link the target link
* @return allocated resources
*/
Iterable<LinkResourceAllocations> getAllocations(Link link); Iterable<LinkResourceAllocations> getAllocations(Link link);
/**
* Returns all allocated resources.
*
* @return allocated resources
*/
Iterable<LinkResourceAllocations> getAllocations(); Iterable<LinkResourceAllocations> getAllocations();
} }