opendaylight/md-sal/sal-protocolbuffer-encoding/src/main/resources/ListenerRegistration.proto

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