com.illumon.iris.db.v2.InstrumentedListenerBase

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

Direct Known Subclasses:: InstrumentedListener, InstrumentedShiftAwareListener

public abstract class InstrumentedListenerBase
extends LivenessArtifact
implements ListenerBase, NotificationQueue.Dependency

The basis for listener implementations.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`InstrumentedListenerBase.ErrorNotification`	The base notification to use when errors occur internally.
`protected class`	`InstrumentedListenerBase.NotificationBase`

Method Summary

Modifier and Type	Method	Description
`com.fishlib.base.log.LogOutput`	`append(com.fishlib.base.log.LogOutput logOutput)`
`boolean`	`canExecute(long step)`	Check if this listener is ready to execute.
`protected void`	`destroy()`	Attempt to release (destructively when necessary) resources held by this object.
`void`	`dropReference()`	Drop a previously-retained reference to this referent.
`UpdatePerformanceTracker.Entry`	`getEntry()`	Get the `entry` that describes the operation this listener is for.
`NotificationQueue.Notification`	`getErrorNotification(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)`	Creates a notification for the exception.
`WeakReference<? extends LivenessReferent>`	`getWeakReference()`	Get a `WeakReference` to this referent.
`void`	`initializeTransientFieldsForLiveness()`	Package-private for `Serializable` sub-classes to use in `readObject` only.
`void`	`onFailure(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)`	Notification of exceptions.
`protected abstract void`	`onFailureInternal(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)`
`protected void`	`onFailureInternalWithDependent(DynamicTable dependent, Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)`
`protected void`	`onReferenceCountAtZero()`	Callback method that will be invoked when the reference count returns to zero.
`boolean`	`satisfied(long step)`	Is this ancestor satisfied? Note that this method must be safe to call on any thread.
`static boolean`	`setVerboseLogging(boolean enableVerboseLogging)`	Enable or disable verbose logging for all `InstrumentedListener`s
`String`	`toString()`
`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, 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, tryManage

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

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Method Details
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class ReferenceCounted
- setVerboseLogging
  
  public static boolean setVerboseLogging(boolean enableVerboseLogging)
  
  Enable or disable verbose logging for all InstrumentedListeners
  
  Parameters:
  
  enableVerboseLogging - true if verbose logging should be enabled
  
  Returns:
  
  the previous setting for verbose logging.
- getEntry
  
  public UpdatePerformanceTracker.Entry getEntry()
  
  Get the entry that describes the operation this listener is for.
  
  Returns:
  
  the UpdatePerformanceTracker.Entry object.
- getErrorNotification
  
  public NotificationQueue.Notification getErrorNotification(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)
  
  Description copied from interface: ListenerBase
  
  Creates a notification for the exception.
  
  Specified by:
  
  getErrorNotification in interface ListenerBase
  
  Parameters:
  
  originalException - exception
  
  sourceEntry - performance tracking
  
  Returns:
  
  exception notification
- 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
  
  public boolean canExecute(long step)
  
  Check if this listener is ready to execute.
  
  Returns:
  
  if this listener is ready to execute
- 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)
- onFailure
  
  public void onFailure(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)
  
  Description copied from interface: ListenerBase
  
  Notification of exceptions.
  
  Specified by:
  
  onFailure in interface ListenerBase
  
  Parameters:
  
  originalException - exception
  
  sourceEntry - performance tracking
- onFailureInternal
  
  protected abstract void onFailureInternal(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)
- onFailureInternalWithDependent
  
  protected final void onFailureInternalWithDependent(DynamicTable dependent, Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry)
- 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 InstrumentedListenerBase