org.onosproject.incubator.net.resource.label

Interface LabelResourceStore

All Superinterfaces:

Store<LabelResourceEvent,LabelResourceDelegate>

@Beta
public interface LabelResourceStore
extends Store<LabelResourceEvent,LabelResourceDelegate>

Manages inventory of label; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<LabelResource>	applyFromDevicePool(DeviceId deviceId, long applyNum) Returns labels from resource pool by a specific device id.
java.util.Collection<LabelResource>	applyFromGlobalPool(long applyNum) Returns labels from the global label resource pool.
boolean	createDevicePool(DeviceId deviceId, LabelResourceId beginLabel, LabelResourceId endLabel) Creates a label resource of some device id from begin label to end label.
boolean	createGlobalPool(LabelResourceId beginLabel, LabelResourceId endLabel) Creates the global label resource pool.
boolean	destroyDevicePool(DeviceId deviceId) Destroys a label resource pool of a specific device id.
boolean	destroyGlobalPool() Destroys a the global label resource pool.
LabelResourcePool	getDeviceLabelResourcePool(DeviceId deviceId) Returns the label resource pool by a specific device id.
long	getFreeNumOfDevicePool(DeviceId deviceId) Returns the unused label number of a label resource pool by a specific device id.
long	getFreeNumOfGlobalPool() Returns the unused number of a global label resource pool.
LabelResourcePool	getGlobalLabelResourcePool() Returns the global label resource pool.
boolean	isDevicePoolFull(DeviceId deviceId) Judges if the pool of a specific device id is full.
boolean	isGlobalPoolFull() Judges if the global resource pool is full.
boolean	releaseToDevicePool(com.google.common.collect.Multimap<DeviceId,LabelResource> release) Releases unused labels to device pools .
boolean	releaseToGlobalPool(java.util.Set<LabelResourceId> release) Releases unused labels to the global resource pool.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

createDevicePool

boolean createDevicePool(DeviceId deviceId,
                         LabelResourceId beginLabel,
                         LabelResourceId endLabel)

Creates a label resource of some device id from begin label to end label.

Parameters:

deviceId - device identifier

beginLabel - represents for the first label id in the range of label pool

endLabel - represents for the last label id in the range of label pool

Returns:

success or fail

createGlobalPool

boolean createGlobalPool(LabelResourceId beginLabel,
                         LabelResourceId endLabel)

Creates the global label resource pool.

Parameters:

beginLabel - represents for the first label id in the range of label pool

endLabel - represents for the last label id in the range of label pool

Returns:

success or fail

destroyDevicePool

boolean destroyDevicePool(DeviceId deviceId)

Destroys a label resource pool of a specific device id.

Parameters:

deviceId - device identifier

Returns:

success or fail

destroyGlobalPool

boolean destroyGlobalPool()

Destroys a the global label resource pool.

Returns:

success or fail

applyFromDevicePool

java.util.Collection<LabelResource> applyFromDevicePool(DeviceId deviceId,
                                                        long applyNum)

Returns labels from resource pool by a specific device id.

Parameters:

deviceId - device identifier

applyNum - the applying number

Returns:

collection of applying labels

applyFromGlobalPool

java.util.Collection<LabelResource> applyFromGlobalPool(long applyNum)

Returns labels from the global label resource pool.

Parameters:

applyNum - apply the number of labels

Returns:

collection of labels

releaseToDevicePool

boolean releaseToDevicePool(com.google.common.collect.Multimap<DeviceId,LabelResource> release)

Releases unused labels to device pools .

Parameters:

release - the collection of releasing labels

Returns:

success or fail

releaseToGlobalPool

boolean releaseToGlobalPool(java.util.Set<LabelResourceId> release)

Releases unused labels to the global resource pool.

Parameters:

release - release the collection of releasing labels

Returns:

success or fail

isDevicePoolFull

boolean isDevicePoolFull(DeviceId deviceId)

Judges if the pool of a specific device id is full.

Parameters:

deviceId - device identifier

Returns:

yes or no

isGlobalPoolFull

boolean isGlobalPoolFull()

Judges if the global resource pool is full.

Returns:

yes or no

getFreeNumOfDevicePool

long getFreeNumOfDevicePool(DeviceId deviceId)

Returns the unused label number of a label resource pool by a specific device id.

Parameters:

deviceId - device identifier

Returns:

number of unused labels

getFreeNumOfGlobalPool

long getFreeNumOfGlobalPool()

Returns the unused number of a global label resource pool.

Returns:

number of unused labels

getDeviceLabelResourcePool

LabelResourcePool getDeviceLabelResourcePool(DeviceId deviceId)

Returns the label resource pool by a specific device id.

Parameters:

deviceId - device identifier

Returns:

the device label resource pool

getGlobalLabelResourcePool

LabelResourcePool getGlobalLabelResourcePool()

Returns the global label resource pool.

Returns:

the global label resource pool