org.onosproject.net.meter

Interface MeterStore

All Superinterfaces:

Store<MeterEvent,MeterStoreDelegate>

public interface MeterStore
extends Store<MeterEvent,MeterStoreDelegate>

Entity that stores and distributed meter objects.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<MeterStoreResult>	deleteMeter(Meter meter) Deletes a meter from the store.
void	deleteMeterNow(Meter m) Delete this meter immediately.
void	failedMeter(MeterOperation op, MeterFailReason reason) Update the store by deleting the failed meter.
Collection<Meter>	getAllMeters() Returns all meters stored in the store.
Meter	getMeter(MeterKey key) Obtains a meter matching the given meter key.
CompletableFuture<MeterStoreResult>	storeMeter(Meter meter) Adds a meter to the store.
CompletableFuture<MeterStoreResult>	updateMeter(Meter meter) Updates a meter whose meter id is the same as the passed meter.
void	updateMeterState(Meter meter) Updates a given meter's state with the provided state.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

storeMeter

CompletableFuture<MeterStoreResult> storeMeter(Meter meter)

Adds a meter to the store.

Parameters:

meter - a meter

Returns:

a future indicating the result of the store operation

deleteMeter

CompletableFuture<MeterStoreResult> deleteMeter(Meter meter)

Deletes a meter from the store.

Parameters:

meter - a meter

Returns:

a future indicating the result of the store operation

updateMeter

CompletableFuture<MeterStoreResult> updateMeter(Meter meter)

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

Parameters:

meter - a new meter

Returns:

a future indicating the result of the store operation

updateMeterState

void updateMeterState(Meter meter)

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

Parameters:

meter - a meter

getMeter

Meter getMeter(MeterKey key)

Obtains a meter matching the given meter key.

Parameters:

key - a meter key

Returns:

a meter

getAllMeters

Collection<Meter> getAllMeters()

Returns all meters stored in the store.

Returns:

a collection of meters

failedMeter

void failedMeter(MeterOperation op,
                 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:

op - a failed meter operation

reason - a failure reason

deleteMeterNow

void deleteMeterNow(Meter m)

Delete this meter immediately.

Parameters:

m - a meter