Open Kilda Java Documentation
Public Member Functions | Static Public Attributes | List of all members
org.openkilda.pce.cache.ResourceCache Class Reference
Inheritance diagram for org.openkilda.pce.cache.ResourceCache:
org.openkilda.pce.cache.Cache

Public Member Functions

 ResourceCache ()
 
void clear ()
 
Integer allocateCookie ()
 
Integer allocateCookie (Integer cookie)
 
Integer deallocateCookie (Integer cookie)
 
Integer allocateVlanId ()
 
Integer allocateVlanId (Integer vlanId)
 
Integer deallocateVlanId (Integer vlanId)
 
synchronized Integer allocateMeterId (SwitchId switchId)
 
synchronized Integer allocateMeterId (SwitchId switchId, Integer meterId)
 
synchronized Integer deallocateMeterId (SwitchId switchId, Integer meterId)
 
synchronized Set< Integer > deallocateMeterId (SwitchId switchId)
 
Set< Integer > getAllCookies ()
 
Set< Integer > getAllVlanIds ()
 
Set< Integer > getAllMeterIds (SwitchId switchId)
 
Map< SwitchId, Set< Integer > > getAllMeterIds ()
 
void allocateFlow (ImmutablePair< Flow, Flow > flow)
 
void deallocateFlow (ImmutablePair< Flow, Flow > flow)
 
String toString ()
 

Static Public Attributes

static final long FLOW_COOKIE_VALUE_MASK = 0x00000000FFFFFFFFL
 
static final long FORWARD_FLOW_COOKIE_MASK = 0x4000000000000000L
 
static final long REVERSE_FLOW_COOKIE_MASK = 0x2000000000000000L
 

Detailed Description

ResourceManager class contains basic operations on resources.

Definition at line 37 of file ResourceCache.java.

Constructor & Destructor Documentation

◆ ResourceCache()

org.openkilda.pce.cache.ResourceCache.ResourceCache ( )

Instance constructor.

Definition at line 108 of file ResourceCache.java.

Member Function Documentation

◆ allocateCookie() [1/2]

Integer org.openkilda.pce.cache.ResourceCache.allocateCookie ( )

Allocates cookie.

Returns
allocated cookie value

Definition at line 125 of file ResourceCache.java.

◆ allocateCookie() [2/2]

Integer org.openkilda.pce.cache.ResourceCache.allocateCookie ( Integer  cookie)

Allocates cookie.

Parameters
cookiecookie value
Returns
allocated cookie value

Definition at line 135 of file ResourceCache.java.

◆ allocateFlow()

void org.openkilda.pce.cache.ResourceCache.allocateFlow ( ImmutablePair< Flow, Flow >  flow)

Allocates flow resources. All flows come here .. single switch and multi switch flows.

Parameters
flowflow

Definition at line 286 of file ResourceCache.java.

◆ allocateMeterId() [1/2]

synchronized Integer org.openkilda.pce.cache.ResourceCache.allocateMeterId ( SwitchId  switchId)

Allocates meter id.

Parameters
switchIdswitch id
Returns
allocated meter id value

Definition at line 194 of file ResourceCache.java.

◆ allocateMeterId() [2/2]

synchronized Integer org.openkilda.pce.cache.ResourceCache.allocateMeterId ( SwitchId  switchId,
Integer  meterId 
)

Allocates meter id.

Parameters
switchIdswitch id
meterIdmeter id value
Returns
allocated meter id value

Definition at line 205 of file ResourceCache.java.

◆ allocateVlanId() [1/2]

Integer org.openkilda.pce.cache.ResourceCache.allocateVlanId ( )

Allocates vlan id.

Returns
allocated vlan id value

Definition at line 159 of file ResourceCache.java.

◆ allocateVlanId() [2/2]

Integer org.openkilda.pce.cache.ResourceCache.allocateVlanId ( Integer  vlanId)

Allocates vlan id.

Parameters
vlanIdvlan id value
Returns
allocated vlan id value

Definition at line 169 of file ResourceCache.java.

◆ clear()

void org.openkilda.pce.cache.ResourceCache.clear ( )

Clears allocated resources.

Definition at line 114 of file ResourceCache.java.

◆ deallocateCookie()

Integer org.openkilda.pce.cache.ResourceCache.deallocateCookie ( Integer  cookie)

Deallocates cookie.

Parameters
cookiecookie value
Returns
deallocated cookie value or null if value was not allocated earlier

Definition at line 150 of file ResourceCache.java.

◆ deallocateFlow()

void org.openkilda.pce.cache.ResourceCache.deallocateFlow ( ImmutablePair< Flow, Flow >  flow)

Deallocates flow resources.

Parameters
flowflow

Definition at line 315 of file ResourceCache.java.

◆ deallocateMeterId() [1/2]

synchronized Integer org.openkilda.pce.cache.ResourceCache.deallocateMeterId ( SwitchId  switchId,
Integer  meterId 
)

Deallocates meter id.

Parameters
switchIdswitch id
meterIdmeter id value
Returns
deallocated meter id value or null if value was not allocated earlier

Definition at line 223 of file ResourceCache.java.

◆ deallocateMeterId() [2/2]

synchronized Set<Integer> org.openkilda.pce.cache.ResourceCache.deallocateMeterId ( SwitchId  switchId)

Deallocates meter id for switch.

Parameters
switchIdswitch id
Returns
deallocated meter id values

Definition at line 234 of file ResourceCache.java.

◆ deallocateVlanId()

Integer org.openkilda.pce.cache.ResourceCache.deallocateVlanId ( Integer  vlanId)

Deallocates vlan id.

Parameters
vlanIdvlan id value
Returns
deallocated vlan id value or null if value was not allocated earlier

Definition at line 184 of file ResourceCache.java.

◆ getAllCookies()

Set<Integer> org.openkilda.pce.cache.ResourceCache.getAllCookies ( )

Gets all allocated cookie values.

Returns
all allocated cookie values

Definition at line 244 of file ResourceCache.java.

◆ getAllMeterIds() [1/2]

Set<Integer> org.openkilda.pce.cache.ResourceCache.getAllMeterIds ( SwitchId  switchId)

Gets all allocated meter id values.

Parameters
switchIdswitch id
Returns
all allocated meter id values

Definition at line 263 of file ResourceCache.java.

◆ getAllMeterIds() [2/2]

Map<SwitchId, Set<Integer> > org.openkilda.pce.cache.ResourceCache.getAllMeterIds ( )

Gets all allocated meter id values.

Returns
all allocated meter id values

Definition at line 272 of file ResourceCache.java.

◆ getAllVlanIds()

Set<Integer> org.openkilda.pce.cache.ResourceCache.getAllVlanIds ( )

Gets all vlan id values.

Returns
all allocated vlan id values

Definition at line 253 of file ResourceCache.java.

◆ toString()

String org.openkilda.pce.cache.ResourceCache.toString ( )

Definition at line 331 of file ResourceCache.java.

Member Data Documentation

◆ FLOW_COOKIE_VALUE_MASK

final long org.openkilda.pce.cache.ResourceCache.FLOW_COOKIE_VALUE_MASK = 0x00000000FFFFFFFFL
static

Flow cookie value mask.

Definition at line 41 of file ResourceCache.java.

◆ FORWARD_FLOW_COOKIE_MASK

final long org.openkilda.pce.cache.ResourceCache.FORWARD_FLOW_COOKIE_MASK = 0x4000000000000000L
static

Forward flow cookie mask.

Definition at line 46 of file ResourceCache.java.

◆ REVERSE_FLOW_COOKIE_MASK

final long org.openkilda.pce.cache.ResourceCache.REVERSE_FLOW_COOKIE_MASK = 0x2000000000000000L
static

Reverse flow cookie mask.

Definition at line 51 of file ResourceCache.java.

The documentation for this class was generated from the following file: