com.inspirel.yami
Interface ValuePublisherOverflowCallback

public interface ValuePublisherOverflowCallback

The callback interface that is used to notify the user code that the message cannot be published without delay due to the overflow condition in one of the subscribers. This callback allows the user to customize the decision that has to be taken in the overflow situation.

Nested Class Summary

static class

ValuePublisherOverflowCallback.OverflowHandling Enumeration type defining possible decisions in the case of notification overflow.

Method Summary

ValuePublisherOverflowCallback.OverflowHandling

subscriptionOverflow(java.lang.String serverName, java.lang.String objectName, YAMISerializable value) Callback function that is automatically called by the value publisher whenever there is an overflow condition for one of the subscribers.

Method Detail

subscriptionOverflow

ValuePublisherOverflowCallback.OverflowHandling subscriptionOverflow(java.lang.String serverName,
                                                                     java.lang.String objectName,
                                                                     YAMISerializable value)
                                                                     throws java.lang.Exception

Callback function that is automatically called by the value publisher whenever there is an overflow condition for one of the subscribers. Note: This function is called in the context of the same thread that initiated the publication of new value.

Parameters:

serverName - target location of the subscriber

objectName - target object name of the subscriber

value - content of the message

Returns:

the user decision on how to handle the overflow condition

Throws:

java.lang.Exception - any exception, which will be interpreted as the "abandon message" decision