public interface DataTreeChangeService extends BindingService
BindingService
which allows users to register for changes to a subtree.Modifier and Type | Method and Description |
---|---|
<T extends DataObject,L extends DataTreeChangeListener<T>> |
registerDataTreeChangeListener(@NonNull DataTreeIdentifier<T> treeId,
L listener)
Registers a
DataTreeChangeListener to receive
notifications when data changes under a given path in the conceptual data
tree. |
<T extends DataObject,L extends DataTreeChangeListener<T>> @NonNull org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerDataTreeChangeListener(@NonNull DataTreeIdentifier<T> treeId, L listener)
DataTreeChangeListener
to receive
notifications when data changes under a given path in the conceptual data
tree.
You are able to register for notifications for any node or subtree
which can be represented using DataTreeIdentifier
.
You are able to register for data change notifications for a subtree or leaf even if it does not exist. You will receive notification once that node is created.
If there is any pre-existing data in the data tree for the path for which you are registering, you will receive an initial data change event, which will contain all pre-existing data, marked as created.
This method returns a ListenerRegistration
object. To
"unregister" your listener for changes call the ListenerRegistration.close()
method on the returned object.
You MUST explicitly unregister your listener when you no longer want to receive notifications. This is especially true in OSGi environments, where failure to do so during bundle shutdown can lead to stale listeners being still registered.
treeId
- Data tree identifier of the subtree which should be watched for
changes.listener
- Listener instance which is being registeredListenerRegistration.close()
to stop
delivery of change events.Copyright © 2019 OpenDaylight. All rights reserved.