org.onosproject.incubator.net.resource.label

Interface LabelResourceService

All Superinterfaces:

org.onosproject.event.ListenerService<LabelResourceEvent,LabelResourceListener>

@Beta
public interface LabelResourceService
extends org.onosproject.event.ListenerService<LabelResourceEvent,LabelResourceListener>

Service for providing label resource allocation.

Method Summary

Modifier and Type	Method and Description
Collection<LabelResource>	applyFromDevicePool(org.onosproject.net.DeviceId deviceId, long applyNum) Returns labels from resource pool by a specific device id.
Collection<LabelResource>	applyFromGlobalPool(long applyNum) Returns labels from the global label resource pool.
LabelResourcePool	getDeviceLabelResourcePool(org.onosproject.net.DeviceId deviceId) Returns the label resource pool of a label resource by a specific device id.
long	getFreeNumOfDevicePool(org.onosproject.net.DeviceId deviceId) Returns the unused label number of a label resource pool by a specific device id.
long	getFreeNumOfGlobalPool() Returns the unused label number of a global label resource pool.
LabelResourcePool	getGlobalLabelResourcePool() Returns the global label resource pool.
boolean	isDevicePoolFull(org.onosproject.net.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<org.onosproject.net.DeviceId,LabelResource> release) Releases unused labels to device pools .
boolean	releaseToGlobalPool(Set<LabelResourceId> release) Releases unused labels to the global resource pool.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

applyFromDevicePool

Collection<LabelResource> applyFromDevicePool(org.onosproject.net.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

Collection<LabelResource> applyFromGlobalPool(long applyNum)

Returns labels from the global label resource pool.

Parameters:

applyNum - the applying number

Returns:

collection of applying labels

releaseToDevicePool

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

Releases unused labels to device pools .

Parameters:

release - the collection of releasing labels

Returns:

success or fail

releaseToGlobalPool

boolean releaseToGlobalPool(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(org.onosproject.net.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(org.onosproject.net.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 label number of a global label resource pool.

Returns:

number of unused labels

getDeviceLabelResourcePool

LabelResourcePool getDeviceLabelResourcePool(org.onosproject.net.DeviceId deviceId)

Returns the label resource pool of a label resource 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