com.illumon.iris.db.v2.MergedListener

All Implemented Interfaces:: com.fishlib.base.log.LogOutputAppendable, NotificationQueue.Dependency, LivenessManager, LivenessNode, LivenessReferent, Serializable

Direct Known Subclasses:: BucketedChunkedAjMergedListener, SnapshotIncrementalListener, ZeroKeyChunkedAjMergedListener

public abstract class MergedListener
extends LivenessArtifact
implements NotificationQueue.Dependency

A merged listener has a collection of ListenerRecorders. Each one must complete before the merged listener fires its sole notification for the cycle. You must use a MergedListener if your result table has multiple sources, otherwise it is possible for a table to produce notifications more than once in a cycle; which is an error.

See Also:: Serialized Form

Field Summary

Fields

Modifier and Type Field Description

protected boolean failed

protected QueryTable result

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`MergedListener(com.fishlib.io.logger.Logger log, Collection<? extends ListenerRecorder> recorders, Collection<NotificationQueue.Dependency> dependencies, String listenerDescription, QueryTable result)`

Method Summary

Modifier and Type	Method	Description
`com.fishlib.base.log.LogOutput`	`append(com.fishlib.base.log.LogOutput logOutput)`
`protected boolean`	`canExecute(long step)`
`protected void`	`destroy()`	Attempt to release (destructively when necessary) resources held by this object.
`void`	`dropReference()`	Drop a previously-retained reference to this referent.
`WeakReference<? extends LivenessReferent>`	`getWeakReference()`	Get a `WeakReference` to this referent.
`void`	`initializeTransientFieldsForLiveness()`	Package-private for `Serializable` sub-classes to use in `readObject` only.
`void`	`notifyChanges()`
`protected void`	`notifyClientOnError(Throwable originalException)`
`protected void`	`notifyOnError(Throwable updateException)`	Notify that an error has occurred.
`protected void`	`notifyOnError(Throwable updateException, QueryTable downstream)`
`protected void`	`onReferenceCountAtZero()`	Callback method that will be invoked when the reference count returns to zero.
`protected abstract void`	`process()`
`boolean`	`satisfied(long step)`	Is this ancestor satisfied? Note that this method must be safe to call on any thread.
`protected boolean`	`systemicResult()`
`boolean`	`tryManage(LivenessReferent referent)`	Attempt to add the specified referent to this manager.
`boolean`	`tryRetainReference()`	If this referent is "live", behave as `LivenessReferent.retainReference()` and return true.

Methods inherited from class com.illumon.iris.db.util.liveness.LivenessArtifact

manageWithCurrentScope, unmanage, unmanage

Methods inherited from class com.illumon.util.referencecounting.ReferenceCounted

decrementReferenceCount, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessManager

manage

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessReferent

getReferentDescription, retainReference

Field Details
- result
  
  protected QueryTable result
- failed
  
  protected boolean failed
Constructor Details
- MergedListener
  
  protected MergedListener(com.fishlib.io.logger.Logger log, Collection<? extends ListenerRecorder> recorders, Collection<NotificationQueue.Dependency> dependencies, String listenerDescription, QueryTable result)
Method Details
- notifyChanges
  
  public void notifyChanges()
- notifyOnError
  
  protected void notifyOnError(Throwable updateException)
  
  Notify that an error has occurred. Note: If this method is overridden, the child class is responsible for updating the failed member when failure processing is complete.
  
  Parameters:
  
  updateException - the exception causing the failure.
- systemicResult
  
  protected boolean systemicResult()
- notifyOnError
  
  protected void notifyOnError(Throwable updateException, QueryTable downstream)
- notifyClientOnError
  
  protected void notifyClientOnError(Throwable originalException)
- process
  
  protected abstract void process()
- append
  
  public com.fishlib.base.log.LogOutput append(@NotNull com.fishlib.base.log.LogOutput logOutput)
  
  Specified by:
  
  append in interface com.fishlib.base.log.LogOutputAppendable
  
  Overrides:
  
  append in class ReferenceCounted
- canExecute
  
  protected boolean canExecute(long step)
- satisfied
  
  public boolean satisfied(long step)
  
  Description copied from interface: NotificationQueue.Dependency
  
  Is this ancestor satisfied? Note that this method must be safe to call on any thread.
  
  Specified by:
  
  satisfied in interface NotificationQueue.Dependency
  
  Parameters:
  
  step - The step for which we are testing satisfaction
  
  Returns:
  
  Whether the dependency is satisfied on step (and will not fire subsequent notifications)
- initializeTransientFieldsForLiveness
  
  @VisibleForTesting public final void initializeTransientFieldsForLiveness()
  
  Package-private for Serializable sub-classes to use in readObject only. Public to allow unit tests in another package to work around mock issues where the constructor is never invoked.
- tryRetainReference
  
  public final boolean tryRetainReference()
  
  Description copied from interface: LivenessReferent
  
  If this referent is "live", behave as LivenessReferent.retainReference() and return true. Otherwise, returns false rather than throwing an exception.
  
  Specified by:
  
  tryRetainReference in interface LivenessReferent
  
  Returns:
  
  True if this referent was retained, false otherwise
- dropReference
  
  public final void dropReference()
  
  Description copied from interface: LivenessReferent
  
  Drop a previously-retained reference to this referent.
  
  Specified by:
  
  dropReference in interface LivenessReferent
- getWeakReference
  
  public WeakReference<? extends LivenessReferent> getWeakReference()
  
  Description copied from interface: LivenessReferent
  
  Get a WeakReference to this referent. This may be cached, or newly created.
  
  Specified by:
  
  getWeakReference in interface LivenessReferent
  
  Returns:
  
  A new or cached reference to this referent
- tryManage
  
  public final boolean tryManage(@NotNull LivenessReferent referent)
  
  Description copied from interface: LivenessManager
  
  Attempt to add the specified referent to this manager.
  
  Specified by:
  
  tryManage in interface LivenessManager
  
  Parameters:
  
  referent - The referent to add
  
  Returns:
  
  Whether the referent was in fact added
- destroy
  
  protected void destroy()
  
  Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().
  This is intended to only ever be used as a side effect of decreasing the reference count to 0.
- onReferenceCountAtZero
  
  protected final void onReferenceCountAtZero()
  
  Description copied from class: ReferenceCounted
  
  Callback method that will be invoked when the reference count returns to zero.
  
  Specified by:
  
  onReferenceCountAtZero in class ReferenceCounted

Class MergedListener

Field Summary