com.illumon.iris.db.v2

Class InstrumentedListenerAdapter

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

com.illumon.iris.db.util.liveness.LivenessArtifact

com.illumon.iris.db.v2.InstrumentedListener

com.illumon.iris.db.v2.InstrumentedListenerAdapter

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, NotificationQueue.Dependency, LivenessManager, LivenessNode, LivenessReferent, Listener, Serializable

public abstract class InstrumentedListenerAdapter
extends InstrumentedListener

This class is used for Listeners that represent "leaf" nodes in the update propagation tree. It provides an optional retention cache, to prevent listeners from being garbage collected. For creating internally ticking table nodes, instead use BaseTable.ListenerImpl

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.InstrumentedListener

InstrumentedListener.ErrorNotification, InstrumentedListener.Notification

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicTable	source

Constructor Summary

Constructors

Constructor and Description
InstrumentedListenerAdapter(DynamicTable source) Create an instrumented listener for source.
InstrumentedListenerAdapter(String description, DynamicTable source) Create an instrumented listener for source.
InstrumentedListenerAdapter(String description, DynamicTable source, boolean retain)

Method Summary

Modifier and Type	Method and Description
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	onFailureInternal(Throwable originalException, UpdatePerformanceTracker.Entry sourceEntry) Called when the source table produces an error
protected void	onReferenceCountAtZero() Callback method that will be invoked when the reference count returns to zero.
abstract void	onUpdate(Index added, Index removed, Index modified) Process notification of table changes.
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.v2.InstrumentedListener

append, getEntry, getErrorNotification, getNotification, onFailure, satisfied, setInitialImage, setVerboseLogging, toString

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.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

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

manage, tryManage

Field Detail

source

@ReferentialIntegrity
protected final DynamicTable source

Constructor Detail

InstrumentedListenerAdapter

public InstrumentedListenerAdapter(DynamicTable source)

Create an instrumented listener for source. The listener will be retained and no description is provided.

Parameters:

source - The source table this listener will subscribe to - needed for preserving referential integrity.

InstrumentedListenerAdapter

public InstrumentedListenerAdapter(@Nullable
                                   String description,
                                   DynamicTable source)

Create an instrumented listener for source. The listener will be retained and no description is provided.

Parameters:

description - A description for the UpdatePerformanceTracker to append to its entry description.

source - The source table this listener will subscribe to - needed for preserving referential integrity.

InstrumentedListenerAdapter

public InstrumentedListenerAdapter(@Nullable
                                   String description,
                                   DynamicTable source,
                                   boolean retain)

Parameters:

description - A description for the UpdatePerformanceTracker to append to its entry description.

source - The source table this listener will subscribe to - needed for preserving referential integrity.

retain - Whether a hard reference to this listener should be maintained to prevent it from being collected.

Method Detail

onUpdate

public abstract void onUpdate(Index added,
                              Index removed,
                              Index modified)

Description copied from interface: Listener

Process notification of table changes.

Specified by:

onUpdate in interface Listener

Specified by:

onUpdate in class InstrumentedListener

Parameters:

added - rows added

removed - rows removed

modified - rows modified

onFailureInternal

public void onFailureInternal(Throwable originalException,
                              UpdatePerformanceTracker.Entry sourceEntry)

Called when the source table produces an error

Specified by:

onFailureInternal in class InstrumentedListener

Parameters:

originalException - the original throwable that caused this error

sourceEntry - the performance tracker entry that was active when the error occurred

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.

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

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