X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fnotify%2FNotificationPublishService.java;h=4a3d86625c755c1042b8cbf6856175d6abe0a526;hb=21bdb94a95aa53487475bcceea70d4f0bb323efa;hp=bb866f276e713151ccf18b0e57e589c65633647f;hpb=b5fcde5020da05b4447d2efd994f3538a7401094;p=controller.git diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java index bb866f276e..4a3d86625c 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/notify/NotificationPublishService.java @@ -11,11 +11,13 @@ import java.util.concurrent.ExecutorService; /** * Interface for publishing YANG-modeled notifications. + * *

* Users of this interface can publish any YANG-modeled notification which will * be delivered to all subscribed listeners. + * *

- * Prefered way of publishing of notifications is done by invoking {@link #publish(Object)}. + * Preferred way of publishing of notifications is done by invoking {@link #publish(Object)}. * *

You may consider using {@link #publish(Object, ExecutorService)} if and only if * your use-case requires customized execution policy or run-to-completion @@ -25,7 +27,7 @@ import java.util.concurrent.ExecutorService; * The metadata required to deliver a notification to the correct listeners is * extracted from the published notification. * - * + *

* FIXME: Consider clarification of execution/delivery policy, how it will be * affected by Actor model and cluster-wide notifications. * @@ -37,6 +39,7 @@ public interface NotificationPublishService { /** * Publishes a notification and notifies subscribed listeners. All listener * notifications are done via a default executor. + * *

* Note: This call will block when the default executor is saturated * and the notification queue for this executor is full. @@ -49,8 +52,9 @@ public interface NotificationPublishService { /** * Publishes a notification and notifies subscribed listeners. All listener * notifications are done via the provided executor. + * *

- * Note: Use only if ineccessary. Consider using + * Note: Use only if necessary. Consider using * {@link #publish(Object)} for most use-cases. * *