opendaylight/md-sal/sal-clustering-commons/src/main/resources/ListenerRegistration.proto

   1 package org.opendaylight.controller.mdsal;
   2
   3 import "Common.proto";
   4
   5 option java_package = "org.opendaylight.controller.protobuff.messages.registration";
   6 option java_outer_classname = "ListenerRegistrationMessages";
   7
   8 /** used when a listener needs to be unregistered*/
   9 message CloseDataChangeListenerRegistration {
  10
  11 }
  12 /** reply to the CloseDataChangeListenerRegistration request*/
  13 message CloseDataChangeListenerRegistrationReply{
  14
  15 }
  16
  17 /**
  18  * When registering a listener at particular level of tree
  19  * identified by instanceIdentifierPath.
  20  * dataChangeListenerActorPath is path to actor that will
  21  * receive the change event
  22  * scope is the data change scope like BASE,ONE and SUBTREE
  23  * defined in AsyncDataBroker.DataChangeScope
  24  */
  25
  26 message RegisterChangeListener{
  27 required InstanceIdentifier instanceIdentifierPath=1;
  28 required string dataChangeListenerActorPath=2;
  29 required int32 dataChangeScope=3;
  30 optional bool registerOnAllInstances=4;
  31 }
  32 /**
  33 * This is the reply for the RegisterChangeListener message
  34 * It contains the listenerRegistration actor path
  35 * that can be used to unregister the listener
  36 */
  37 message RegisterChangeListenerReply{
  38 required string listenerRegistrationPath=1;
  39
  40 }
  41