com.avaya.conferencing.api.acp.control.events
Interface SourceSequentialEventListener

public interface SourceSequentialEventListener

A marker interface for event listeners that will ensure that events are notified in the order in which they occur in return for the listener committing to an upper bound on the number of events that are pending notification.

Since:

5.1.0.0.40

Method Summary

void	eventBacklogPurged(java.lang.Object source, int purgeCount) This method will be called (on a separate thread) whenever events are purged from the event queue, either because there are more than getEventBacklogLimit() * 4 events which have not been processed, or because a call to eventBacklogWarning(Object, int) returned true.
boolean	eventBacklogWarning(java.lang.Object source, int queueSize) This method will be called (on a separate thread) every Math.min(getEventBacklogLimit() / 32, 1) events queued for a specific source instance once the unprocessed event queue is longer than getEventBacklogLimit().
int	getEventBacklogLimit() Controls when and how often eventBacklogWarning(Object, int) and eventBacklogPurged(Object, int) will be called.

Method Detail

getEventBacklogLimit

int getEventBacklogLimit()

Controls when and how often eventBacklogWarning(Object, int) and eventBacklogPurged(Object, int) will be called. If the value returned is less than 1 it will be treated as if it is equal to 1. If the value returned is greater than 1024 it may be treated as equal to 1024.

Returns:

a positive integer greater than 1.

eventBacklogWarning

boolean eventBacklogWarning(java.lang.Object source,
                            int queueSize)

This method will be called (on a separate thread) every Math.min(getEventBacklogLimit() / 32, 1) events queued for a specific source instance once the unprocessed event queue is longer than getEventBacklogLimit(). Note if this method takes longer than 50ms to complete, it will be assumed to have returned false.

Parameters:

source - The object with the excess of events.

queueSize - The current number of events.

Returns:

true to purge events until there are less than getEventBacklogLimit() / 2 events or false to ignore the warning.

eventBacklogPurged

void eventBacklogPurged(java.lang.Object source,
                        int purgeCount)

This method will be called (on a separate thread) whenever events are purged from the event queue, either because there are more than getEventBacklogLimit() * 4 events which have not been processed, or because a call to eventBacklogWarning(Object, int) returned true.

Parameters:

source - The object with the excess of events.

purgeCount - The number of events that were purged.