X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fapi%2FDOMNotificationPublishService.java;h=3b6a88fe91de9c94a8d10554b021adafa620ebd0;hb=7c1be1d20084ee053747d517d597f1a07df694bd;hp=f80a124a8d08348719a9ab02a79423cc84bb0661;hpb=a81d98f692b80c45bce3fe6a87e731abfb012a9f;p=controller.git diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java index f80a124a8d..3b6a88fe91 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMNotificationPublishService.java @@ -29,7 +29,8 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * Well-known value indicating that the implementation is currently not * able to accept a notification. */ - ListenableFuture REJECTED = Futures.immediateFailedFuture(new DOMNotificationRejectedException("Unacceptable blocking conditions encountered")); + ListenableFuture REJECTED = Futures.immediateFailedFuture( + new DOMNotificationRejectedException("Unacceptable blocking conditions encountered")); /** * Publish a notification. The result of this method is a {@link ListenableFuture} @@ -38,6 +39,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * and implementations may use it to convey additional information related to the * publishing process. * + *

* Abstract subclasses can refine the return type as returning a promise of a * more specific type, e.g.: * @@ -46,6 +48,7 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * ListenableFuture putNotification(DOMNotification notification); * } * + *

* Once the Future succeeds, the resulting object can be queried for traits using * instanceof, e.g: * @@ -58,10 +61,12 @@ public interface DOMNotificationPublishService extends DOMService, BrokerService * } * } * + *

* In case an implementation is running out of resources, it can block the calling * thread until enough resources become available to accept the notification for * processing, or it is interrupted. * + *

* Caution: completion here means that the implementation has completed processing * of the notification. This does not mean that all existing registrants * have seen the notification. Most importantly, the delivery process at