Interface IKeyspaceMonitor
public interface IKeyspaceMonitor
A keyspace monitor is capable of "monitoring" the keys in a key-value store and notify listeners when a key is set,
deleted or when a key expires.
- Since:
- 11.0
- Author:
- Petru Galanton
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddListener(IKeyPattern keyPattern, IKeyspaceEventListener listener) Registers the given listener for the given key pattern.voidaddListener(String key, IKeyspaceEventListener listener) Registers the given listener for the given key.Returns a builder for creating key patterns.voidremoveListener(IKeyPattern keyPattern, IKeyspaceEventListener listener) Unregisters the given listener from the given key pattern.voidremoveListener(String key, IKeyspaceEventListener listener) Unregisters the given listener from the given key.
-
Method Details
-
addListener
Registers the given listener for the given key.- Parameters:
key- the key to monitorlistener- the listener to notify when events occur for the given key
-
addListener
Registers the given listener for the given key pattern. The listener will be notified of events for any keys in the key-value store which match the given pattern.- Parameters:
keyPattern- the key pattern to monitorlistener- the listener to be notified
-
removeListener
Unregisters the given listener from the given key.- Parameters:
key- the keylistener- the listener to unregister
-
removeListener
Unregisters the given listener from the given key pattern.- Parameters:
keyPattern- the key patternlistener- the listener to unregister
-
getKeyPatternBuilder
IKeyPatternBuilder getKeyPatternBuilder()Returns a builder for creating key patterns.- Returns:
- a key pattern builder.
-