org.opendaylight.mdsal.binding.dom.adapter

Class BindingDOMNotificationPublishServiceAdapter

java.lang.Object

org.opendaylight.mdsal.binding.dom.adapter.BindingDOMNotificationPublishServiceAdapter

All Implemented Interfaces:

AutoCloseable, BindingService, NotificationPublishService

public class BindingDOMNotificationPublishServiceAdapter
extends Object
implements NotificationPublishService, AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BindingDOMNotificationPublishServiceAdapter.Builder

Field Summary

Fields inherited from interface org.opendaylight.mdsal.binding.api.NotificationPublishService

REJECTED

Constructor Summary

Constructors

Constructor and Description
BindingDOMNotificationPublishServiceAdapter(BindingToNormalizedNodeCodec codec, DOMNotificationPublishService domPublishService)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingDOMNotificationPublishServiceAdapter

public BindingDOMNotificationPublishServiceAdapter(BindingToNormalizedNodeCodec codec,
                                                   DOMNotificationPublishService domPublishService)

Method Detail

getCodecRegistry

public BindingToNormalizedNodeCodec getCodecRegistry()

getDomPublishService

public DOMNotificationPublishService getDomPublishService()

putNotification

public void putNotification(Notification notification)
                     throws InterruptedException

Description copied from interface: NotificationPublishService

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.

Specified by:

putNotification in interface NotificationPublishService

Parameters:

notification - the notification to publish.

Throws:

InterruptedException - if interrupted while waiting

offerNotification

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

Description copied from interface: NotificationPublishService

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.

Specified by:

offerNotification in interface NotificationPublishService

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 NotificationPublishService.REJECTED if resource constraints prevent

offerNotification

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

Description copied from interface: NotificationPublishService

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.

Specified by:

offerNotification in interface NotificationPublishService

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 NotificationPublishService.REJECTED if resource constraints prevent

Throws:

InterruptedException - if interrupted while waiting

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception