Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.resource; |
2 | |||||
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 3 | import org.onlab.onos.net.Link; |
4 | import org.onlab.onos.net.intent.IntentId; | ||||
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 5 | |
6 | /** | ||||
7 | * Service for providing link resource allocation. | ||||
8 | */ | ||||
9 | public interface LinkResourceService { | ||||
10 | |||||
11 | /** | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 12 | * Requests resources. |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 13 | * |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 14 | * @param req resources to be allocated |
15 | * @return allocated resources | ||||
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 16 | */ |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 17 | LinkResourceAllocations requestResources(LinkResourceRequest req); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 18 | |
19 | /** | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 20 | * Releases resources. |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 21 | * |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 22 | * @param allocations resources to be released |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 23 | */ |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 24 | void releaseResources(LinkResourceAllocations allocations); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 25 | |
26 | /** | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 27 | * Returns all allocated resources. |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 28 | * |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 29 | * @return allocated resources |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 30 | */ |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 31 | Iterable<LinkResourceAllocations> getAllocations(); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 32 | |
Brian O'Connor | e7e4bd5 | 2014-10-23 13:36:23 -0700 | [diff] [blame^] | 33 | LinkResourceAllocations getAllocation(IntentId intentId); |
34 | |||||
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 35 | /** |
36 | * Returns all allocated resources to given link. | ||||
37 | * | ||||
38 | * @param link a target link | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 39 | * @return allocated resources |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 40 | */ |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 41 | Iterable<LinkResourceAllocations> getAllocations(Link link); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 42 | |
43 | /** | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 44 | * Returns all IDs of intents using the given link. |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 45 | * |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 46 | * @param link a target link |
47 | * @return IDs of intents using the link | ||||
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 48 | */ |
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 49 | Iterable<IntentId> getIntents(Link link); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 50 | |
51 | /** | ||||
52 | * Returns available resources for given link. | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 53 | * |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 54 | * @param link a target link |
55 | * @return available resources for the target link | ||||
56 | */ | ||||
Toshio Koide | 485b478 | 2014-10-20 19:34:21 -0700 | [diff] [blame] | 57 | ResourceRequest getAvailableResources(Link link); |
Toshio Koide | c9051db | 2014-10-20 15:18:37 -0700 | [diff] [blame] | 58 | } |