org.onosproject.incubator.net.virtual

Interface VirtualNetworkMeterStore

All Superinterfaces:

VirtualStore<org.onosproject.net.meter.MeterEvent,org.onosproject.net.meter.MeterStoreDelegate>

public interface VirtualNetworkMeterStore
extends VirtualStore<org.onosproject.net.meter.MeterEvent,org.onosproject.net.meter.MeterStoreDelegate>

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	deleteMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Deletes a meter from the store.
org.onosproject.net.meter.MeterStoreResult	deleteMeterFeatures(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Deletes the meter features from the store.
void	deleteMeterNow(NetworkId networkId, org.onosproject.net.meter.Meter m) Delete this meter immediately.
void	failedMeter(NetworkId networkId, org.onosproject.net.meter.MeterOperation op, org.onosproject.net.meter.MeterFailReason reason) Update the store by deleting the failed meter.
Collection<org.onosproject.net.meter.Meter>	getAllMeters(NetworkId networkId) Returns all meters stored in the store.
long	getMaxMeters(NetworkId networkId, org.onosproject.net.meter.MeterFeaturesKey key) Retrieve maximum meters available for the device.
org.onosproject.net.meter.Meter	getMeter(NetworkId networkId, org.onosproject.net.meter.MeterKey key) Obtains a meter matching the given meter key.
CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	storeMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Adds a meter to the store.
org.onosproject.net.meter.MeterStoreResult	storeMeterFeatures(NetworkId networkId, org.onosproject.net.meter.MeterFeatures meterfeatures) Adds the meter features to the store.
CompletableFuture<org.onosproject.net.meter.MeterStoreResult>	updateMeter(NetworkId networkId, org.onosproject.net.meter.Meter meter) Updates a meter whose meter id is the same as the passed meter.
void	updateMeterState(NetworkId networkId, org.onosproject.net.meter.Meter meter) Updates a given meter's state with the provided state.

Methods inherited from interface org.onosproject.incubator.net.virtual.VirtualStore

hasDelegate, setDelegate, unsetDelegate

Method Detail

storeMeter

CompletableFuture<org.onosproject.net.meter.MeterStoreResult> storeMeter(NetworkId networkId,
                                                                         org.onosproject.net.meter.Meter meter)

Adds a meter to the store.

Parameters:

networkId - a virtual network identifier

meter - a meter

Returns:

a future indicating the result of the store operation

deleteMeter

CompletableFuture<org.onosproject.net.meter.MeterStoreResult> deleteMeter(NetworkId networkId,
                                                                          org.onosproject.net.meter.Meter meter)

Deletes a meter from the store.

Parameters:

networkId - a virtual network identifier

meter - a meter

Returns:

a future indicating the result of the store operation

storeMeterFeatures

org.onosproject.net.meter.MeterStoreResult storeMeterFeatures(NetworkId networkId,
                                                              org.onosproject.net.meter.MeterFeatures meterfeatures)

Adds the meter features to the store.

Parameters:

networkId - a virtual network identifier

meterfeatures - the meter features

Returns:

the result of the store operation

deleteMeterFeatures

org.onosproject.net.meter.MeterStoreResult deleteMeterFeatures(NetworkId networkId,
                                                               org.onosproject.net.DeviceId deviceId)

Deletes the meter features from the store.

Parameters:

networkId - a virtual network identifier

deviceId - the device id

Returns:

a future indicating the result of the store operation

updateMeter

CompletableFuture<org.onosproject.net.meter.MeterStoreResult> updateMeter(NetworkId networkId,
                                                                          org.onosproject.net.meter.Meter meter)

Updates a meter whose meter id is the same as the passed meter.

Parameters:

networkId - a virtual network identifier

meter - a new meter

Returns:

a future indicating the result of the store operation

updateMeterState

void updateMeterState(NetworkId networkId,
                      org.onosproject.net.meter.Meter meter)

Updates a given meter's state with the provided state.

Parameters:

networkId - a virtual network identifier

meter - a meter

getMeter

org.onosproject.net.meter.Meter getMeter(NetworkId networkId,
                                         org.onosproject.net.meter.MeterKey key)

Obtains a meter matching the given meter key.

Parameters:

networkId - a virtual network identifier

key - a meter key

Returns:

a meter

getAllMeters

Collection<org.onosproject.net.meter.Meter> getAllMeters(NetworkId networkId)

Returns all meters stored in the store.

Parameters:

networkId - a virtual network identifier

Returns:

a collection of meters

failedMeter

void failedMeter(NetworkId networkId,
                 org.onosproject.net.meter.MeterOperation op,
                 org.onosproject.net.meter.MeterFailReason reason)

Update the store by deleting the failed meter. Notifies the delegate that the meter failed to allow it to nofity the app.

Parameters:

networkId - a virtual network identifier

op - a failed meter operation

reason - a failure reason

deleteMeterNow

void deleteMeterNow(NetworkId networkId,
                    org.onosproject.net.meter.Meter m)

Delete this meter immediately.

Parameters:

networkId - a virtual network identifier

m - a meter

getMaxMeters

long getMaxMeters(NetworkId networkId,
                  org.onosproject.net.meter.MeterFeaturesKey key)

Retrieve maximum meters available for the device.

Parameters:

networkId - a virtual network identifier

key - the meter features key

Returns:

the maximum number of meters supported by the device