org.opendaylight.mdsal.binding.api

Interface NotificationPublishService

All Superinterfaces:

BindingService

All Known Implementing Classes:

BindingDOMNotificationPublishServiceAdapter

public interface NotificationPublishService
extends BindingService

A NotificationService which also allows its users to submit YANG-modeled notifications for delivery. There are three methods of submission, following the patters from BlockingQueue: - putNotification(Notification), which may block indefinitely if the implementation cannot allocate resources to accept the notification, - offerNotification(Notification), which does not block if face of resource starvation, - offerNotification(Notification, int, TimeUnit), which may block for specified time if resources are thin.

The actual delivery to listeners is asynchronous and implementation-specific. Users of this interface should not make any assumptions as to whether the notification has or has not been seen.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.util.concurrent.ListenableFuture<Object>	REJECTED Well-known value indicating that the binding-aware implementation is currently not able to accept a notification.

Method Summary

Modifier and Type	Method and Description
@NonNull com.google.common.util.concurrent.ListenableFuture<? extends Object>	offerNotification(@NonNull Notification notification) Publishes a notification to subscribed listeners.
@NonNull com.google.common.util.concurrent.ListenableFuture<? extends Object>	offerNotification(@NonNull Notification notification, int timeout, @NonNull TimeUnit unit) Publishes a notification to subscribed listeners.
void	putNotification(@NonNull Notification notification) Publishes a notification to subscribed listeners.

Field Detail

REJECTED

static final com.google.common.util.concurrent.ListenableFuture<Object> REJECTED

Well-known value indicating that the binding-aware implementation is currently not able to accept a notification.

Method Detail

putNotification

void putNotification(@NonNull Notification notification)
              throws InterruptedException

Publishes a notification to subscribed listeners. This initiates the process of sending the notification, but delivery to the listeners can happen asynchronously, potentially after a call to this method returns. Note: This call will block when the notification queue is full.

Parameters:

notification - the notification to publish.

Throws:

InterruptedException - if interrupted while waiting

NullPointerException - if the notification is null

offerNotification

@NonNull com.google.common.util.concurrent.ListenableFuture<? extends Object> offerNotification(@NonNull Notification notification)

Publishes a notification to subscribed listeners. This initiates the process of sending the notification, but delivery to the listeners can happen asynchronously, potentially after a call to this method returns.

Still guaranteed not to block. Returns Listenable Future which will complete once.

Parameters:

notification - the notification to publish.

Returns:

A listenable future which will report completion when the service has finished propagating the notification to its immediate registrants, or REJECTED if resource constraints prevent

Throws:

NullPointerException - if the notification is null

offerNotification

@NonNull com.google.common.util.concurrent.ListenableFuture<? extends Object> offerNotification(@NonNull Notification notification,
                                                                                                int timeout,
                                                                                                @NonNull TimeUnit unit)
                                                                                         throws InterruptedException

Publishes a notification to subscribed listeners. This initiates the process of sending the notification, but delivery to the listeners can happen asynchronously, potentially after a call to this method returns. This method is guaranteed not to block more than the specified timeout.

Parameters:

notification - the notification to publish.

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

A listenable future which will report completion when the service has finished propagating the notification to its immediate registrants, or REJECTED if resource constraints prevent

Throws:

InterruptedException - if interrupted while waiting

NullPointerException - if the notification or unit is null

IllegalArgumentException - if timeout is negative.