org.opendaylight.controller.md.sal.dom.spi

Class ForwardingDOMNotificationPublishService

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.controller.md.sal.dom.spi.ForwardingDOMNotificationPublishService

All Implemented Interfaces:

DOMNotificationPublishService, org.opendaylight.mdsal.dom.api.DOMService

public abstract class ForwardingDOMNotificationPublishService
extends com.google.common.collect.ForwardingObject
implements DOMNotificationPublishService

Utility implementations of DOMNotificationPublishService which forwards all requests to a delegate instance.

Field Summary

Fields inherited from interface org.opendaylight.controller.md.sal.dom.api.DOMNotificationPublishService

REJECTED

Constructor Summary

Constructors

Constructor and Description
ForwardingDOMNotificationPublishService()

Method Summary

Modifier and Type	Method and Description
protected abstract DOMNotificationPublishService	delegate()
com.google.common.util.concurrent.ListenableFuture<?>	offerNotification(DOMNotification notification) Attempt to publish a notification.
com.google.common.util.concurrent.ListenableFuture<?>	offerNotification(DOMNotification notification, long timeout, TimeUnit unit) Attempt to publish a notification.
com.google.common.util.concurrent.ListenableFuture<?>	putNotification(DOMNotification notification) Publish a notification.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForwardingDOMNotificationPublishService

public ForwardingDOMNotificationPublishService()

Method Detail

delegate

protected abstract DOMNotificationPublishService delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

putNotification

public com.google.common.util.concurrent.ListenableFuture<?> putNotification(DOMNotification notification)
                                                                      throws InterruptedException

Description copied from interface: DOMNotificationPublishService

Publish a notification. The result of this method is a ListenableFuture which will complete once the notification has been delivered to all immediate registrants. The type of the object resulting from the future is not defined 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.: public interface DeliveryStatus { int getListenerCount(); } ListenableFuture<? extends DeliveryStatus> putNotification(DOMNotification notification);

Once the Future succeeds, the resulting object can be queried for traits using instanceof, e.g: // Can block when (for example) the implemention's ThreadPool queue is full Object o = service.putNotification(notif).get(); if (o instanceof DeliveryStatus) { DeliveryStatus ds = (DeliveryStatus)o; LOG.debug("Notification was received by {} listeners", ds.getListenerCount();); }

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 other cluster nodes may have not begun yet.

Specified by:

putNotification in interface DOMNotificationPublishService

Parameters:

notification - Notification to be published.

Returns:

A listenable future which will report completion when the service has finished propagating the notification to its immediate registrants.

Throws:

InterruptedException - if interrupted while waiting

offerNotification

public com.google.common.util.concurrent.ListenableFuture<?> offerNotification(DOMNotification notification)

Description copied from interface: DOMNotificationPublishService

Attempt to publish a notification. The result of this method is a ListenableFuture which will complete once the notification has been delivered to all immediate registrants. The type of the object resulting from the future is not defined and implementations may use it to convey additional information related to the publishing process. Unlike DOMNotificationPublishService.putNotification(DOMNotification), this method is guaranteed not to block if the underlying implementation encounters contention.

Specified by:

offerNotification in interface DOMNotificationPublishService

Parameters:

notification - Notification to be published.

Returns:

A listenable future which will report completion when the service has finished propagating the notification to its immediate registrants, or DOMNotificationPublishService.REJECTED if resource constraints prevent the implementation from accepting the notification for delivery.

offerNotification

public com.google.common.util.concurrent.ListenableFuture<?> offerNotification(DOMNotification notification,
                                                                               long timeout,
                                                                               TimeUnit unit)
                                                                        throws InterruptedException

Description copied from interface: DOMNotificationPublishService

Attempt to publish a notification. The result of this method is a ListenableFuture which will complete once the notification has been delivered to all immediate registrants. The type of the object resulting from the future is not defined and implementations may use it to convey additional information related to the publishing process. Unlike DOMNotificationPublishService.putNotification(DOMNotification), this method is guaranteed to block more than the specified timeout.

Specified by:

offerNotification in interface DOMNotificationPublishService

Parameters:

notification - Notification to be published.

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 DOMNotificationPublishService.REJECTED if resource constraints prevent the implementation from accepting the notification for delivery.

Throws:

InterruptedException - if interrupted while waiting