public interface MappingStore extends org.onosproject.store.Store<MappingEvent,MappingStoreDelegate>
| Modifier and Type | Interface and Description |
|---|---|
static class |
MappingStore.Type
Represents the type of mapping store.
|
| Modifier and Type | Method and Description |
|---|---|
MappingEvent |
addOrUpdateMappingEntry(MappingStore.Type type,
MappingEntry entry)
Stores a new mapping or updates an existing entry from/to the
specified store.
|
Iterable<MappingEntry> |
getAllMappingEntries(MappingStore.Type type)
Obtains all mapping entries from the specified store.
|
int |
getMappingCount(MappingStore.Type type)
Obtains the number of mapping in the specified store.
|
Iterable<MappingEntry> |
getMappingEntries(MappingStore.Type type,
org.onosproject.net.DeviceId deviceId)
Obtains the mapping entries associated with a device from the
specified store.
|
MappingEntry |
getMappingEntry(MappingStore.Type type,
Mapping mapping)
Obtains the stored mapping from the specified store.
|
void |
pendingDeleteMapping(MappingStore.Type type,
Mapping mapping)
Marks a mapping for deletion.
|
MappingEvent |
pendingMappingEntry(MappingStore.Type type,
MappingEntry entry)
Marks a mapping as PENDING_ADD during retry.
|
void |
purgeMappingEntries(MappingStore.Type type)
Removes all mapping entries from the specified store.
|
default void |
purgeMappingEntry(MappingStore.Type type,
org.onosproject.net.DeviceId deviceId)
Removes all mapping entries of given device from the specified store.
|
MappingEvent |
removeMapping(MappingStore.Type type,
Mapping mapping)
Removes an existing mapping from the specified store.
|
void |
storeMapping(MappingStore.Type type,
MappingEntry mapping)
Stores a new mapping.
|
int getMappingCount(MappingStore.Type type)
type - store typeIterable<MappingEntry> getAllMappingEntries(MappingStore.Type type)
type - store typeMappingEntry getMappingEntry(MappingStore.Type type, Mapping mapping)
type - store typemapping - the mapping to look forIterable<MappingEntry> getMappingEntries(MappingStore.Type type, org.onosproject.net.DeviceId deviceId)
type - store typedeviceId - device identifiervoid storeMapping(MappingStore.Type type, MappingEntry mapping)
type - store typemapping - the mapping to addvoid pendingDeleteMapping(MappingStore.Type type, Mapping mapping)
type - store typemapping - the mapping to be marked as deleteMappingEvent removeMapping(MappingStore.Type type, Mapping mapping)
type - store typemapping - the mapping to removeMappingEvent addOrUpdateMappingEntry(MappingStore.Type type, MappingEntry entry)
type - store typeentry - the mapping to add or updateMappingEvent pendingMappingEntry(MappingStore.Type type, MappingEntry entry)
Emits mapping_update event if the state is changed
type - store typeentry - the mapping that is retryingdefault void purgeMappingEntry(MappingStore.Type type, org.onosproject.net.DeviceId deviceId)
type - store typedeviceId - device identifiervoid purgeMappingEntries(MappingStore.Type type)
type - store type