blob: bb86d4756886307bcfd56898f2fb84c884bf371b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
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();
}
|