Changed RegisterChangeListener and RegisterChangeListenerReply

[controller.git] / opendaylight / md-sal / sal-protocolbuffer-encoding / src / main / resources / ListenerRegistration.proto

diff --git a/opendaylight/md-sal/sal-protocolbuffer-encoding/src/main/resources/ListenerRegistration.proto b/opendaylight/md-sal/sal-protocolbuffer-encoding/src/main/resources/ListenerRegistration.proto
index 3efe05d31e0b803dd8bf91baea010f14238e4d41..b3eb2ed4bdeb252d43314e3f29d4ee98e70a8b03 100644 (file)
--- a/opendaylight/md-sal/sal-protocolbuffer-encoding/src/main/resources/ListenerRegistration.proto
+++ b/opendaylight/md-sal/sal-protocolbuffer-encoding/src/main/resources/ListenerRegistration.proto
@@ -3,11 +3,36 @@ package org.opendaylight.controller.mdsal;
 option java_package = "org.opendaylight.controller.protobuff.messages.registration";
 option java_outer_classname = "ListenerRegistrationMessages";
 
+/** used when a listener needs to be unregistered*/
 message CloseDataChangeListenerRegistration {
 
 }
-
+/** reply to the CloseDataChangeListenerRegistration request*/
 message CloseDataChangeListenerRegistrationReply{
 
 }
 
+/**
+ * When registering a listener at particular level of tree
+ * identified by instanceIdentifierPath.
+ * dataChangeListenerActorPath is path to actor that will
+ * receive the change event
+ * scope is the data change scope like BASE,ONE and SUBTREE
+ * defined in AsyncDataBroker.DataChangeScope
+ */
+
+message RegisterChangeListener{
+required string instanceIdentifierPath=1;
+required string dataChangeListenerActorPath=2;
+required int32 dataChangeScope=3;
+}
+/**
+* This is the reply for the RegisterChangeListener message
+* It contains the listenerRegistration actor path
+* that can be used to unregister the listener
+*/
+message RegisterChangeListenerReply{
+required string listenerRegistrationPath=1;
+
+}
+