org.onosproject.incubator.net.resource.label

Class LabelResourcePool

java.lang.Object

org.onosproject.incubator.net.resource.label.LabelResourcePool

@Beta
public class LabelResourcePool
extends java.lang.Object

Abstraction of the capacity of device label resource or global label resource. It's contiguous range of label resource. When a application apply some labels of some device, first catch from Set that store available labels, if the size of the Set less than the apply number, then get labels by calculating with three attributes, beginLabel,endLabel and currentUsedMaxLabelId.

Constructor Summary

Constructors

Constructor and Description
LabelResourcePool(java.lang.String deviceId, long beginLabel, long endLabel) Creates a pool by device id,begin label id,end label id.
LabelResourcePool(java.lang.String deviceId, long beginLabel, long endLabel, long totalNum, long usedNum, long currentUsedMaxLabelId, com.google.common.collect.ImmutableSet<LabelResource> releaseLabelId) Creates a pool by device id,begin label id,end label id.

Method Summary

Modifier and Type	Method and Description
LabelResourceId	beginLabel() Returns a begin Label id.
LabelResourceId	currentUsedMaxLabelId() Returns a begin Label id.
DeviceId	deviceId() Returns a device id.
LabelResourceId	endLabel() Returns an end Label id.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.util.Set<LabelResource>	releaseLabelId() Returns the Set of released label before.
java.lang.String	toString()
long	totalNum() Returns total number.
long	usedNum() Returns used number.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelResourcePool

public LabelResourcePool(java.lang.String deviceId,
                         long beginLabel,
                         long endLabel)

Creates a pool by device id,begin label id,end label id.

Parameters:

deviceId - device identifier

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

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

LabelResourcePool

public LabelResourcePool(java.lang.String deviceId,
                         long beginLabel,
                         long endLabel,
                         long totalNum,
                         long usedNum,
                         long currentUsedMaxLabelId,
                         com.google.common.collect.ImmutableSet<LabelResource> releaseLabelId)

Creates a pool by device id,begin label id,end label id. Used to update a pool in the store.

Parameters:

deviceId - device identifier

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

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

totalNum - capacity of label resource pool

usedNum - have used label number

currentUsedMaxLabelId - the maximal label number id

releaseLabelId - Set of released label

Method Detail

deviceId

public DeviceId deviceId()

Returns a device id.

Returns:

DeviceId

beginLabel

public LabelResourceId beginLabel()

Returns a begin Label id.

Returns:

begin Label id

endLabel

public LabelResourceId endLabel()

Returns an end Label id.

Returns:

end Label id

currentUsedMaxLabelId

public LabelResourceId currentUsedMaxLabelId()

Returns a begin Label id.

Returns:

current Used Maximal Label Id

totalNum

public long totalNum()

Returns total number.

Returns:

the total label number

usedNum

public long usedNum()

Returns used number.

Returns:

the used label number

releaseLabelId

public java.util.Set<LabelResource> releaseLabelId()

Returns the Set of released label before.

Returns:

the Set of LabelResource

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object