org.opendaylight.controller.md.sal.common.api.notify

Interface NotificationPublishService<N>

Type Parameters:

N - the type of notifications

All Known Subinterfaces:

NotificationProviderService

All Known Implementing Classes:

AbstractBindingSalProviderInstance, HeliumNotificationProviderServiceAdapter, HeliumNotificationProviderServiceWithInterestListeners, RootBindingAwareBroker.RootSalInstance

public interface NotificationPublishService<N>

Interface for publishing YANG-modeled notifications.

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

Preferred way of publishing of notifications is done by invoking publish(Object).

You may consider using publish(Object, ExecutorService) if and only if your use-case requires customized execution policy or run-to-completion inside process.

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.

Method Summary

Modifier and Type	Method and Description
void	publish(N notification) Publishes a notification and notifies subscribed listeners.
void	publish(N notification, ExecutorService executor) Publishes a notification and notifies subscribed listeners.

Method Detail

publish

void publish(N notification)

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.

Parameters:

notification - the notification to publish.

publish

void publish(N notification,
             ExecutorService executor)

Publishes a notification and notifies subscribed listeners. All listener notifications are done via the provided executor.

Note: Use only if necessary. Consider using publish(Object) for most use-cases.

By using this method you could customize execution policy of listeners present inside process (e.g. using single-threaded executor or even same-thread executor delivery.

This executor is used only for inside-process notification deliveries.

Parameters:

notification - the notification to publish.

executor - the executor that will be used to deliver notifications to subscribed listeners.