Package com.illumon.iris.db.v2

Class ShiftAwareSwapListener

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

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

com.illumon.iris.db.v2.SwapListenerBase<ShiftAwareListener>

com.illumon.iris.db.v2.ShiftAwareSwapListener

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ListenerBase, ShiftAwareListener, Serializable

public class ShiftAwareSwapListener
extends SwapListenerBase<ShiftAwareListener>
implements ShiftAwareListener

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.ShiftAwareListener

ShiftAwareListener.Update

Field Summary

Fields inherited from class com.illumon.iris.db.v2.SwapListenerBase

DEBUG

Constructor Summary

Constructors

Constructor	Description
ShiftAwareSwapListener(com.fishlib.io.logger.Logger log, BaseTable sourceTable)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
void	dropReference()	Drop a previously-retained reference to this referent.
NotificationQueue.IndexUpdateNotification	getNotification(ShiftAwareListener.Update update)	Creates a notification for the table changes.
WeakReference<? extends LivenessReferent>	getWeakReference()	Get a WeakReference to this referent.
void	initializeTransientFieldsForLiveness()	Package-private for Serializable sub-classes to use in readObject only.
protected void	onReferenceCountAtZero()	Callback method that will be invoked when the reference count returns to zero.
void	onUpdate(ShiftAwareListener.Update upstream)	Process notification of table changes.
void	subscribeForUpdates()	Invoke DynamicTable.listenForUpdates(Listener) for the appropriate subclass of SwapListenerBase.
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.SwapListenerBase

end, getErrorNotification, makeSnapshotControl, onFailure, setListenerAndResult, start

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

manageWithCurrentScope, unmanage, unmanage

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

append, 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.v2.ListenerBase

getErrorNotification, onFailure

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

Constructor Details

ShiftAwareSwapListener

public ShiftAwareSwapListener(com.fishlib.io.logger.Logger log, BaseTable sourceTable)

Method Details

onUpdate

public void onUpdate(ShiftAwareListener.Update upstream)

Description copied from interface: ShiftAwareListener

Process notification of table changes.

Specified by:

onUpdate in interface ShiftAwareListener

Parameters:

upstream - The set of upstream table updates.

getNotification

public NotificationQueue.IndexUpdateNotification getNotification(ShiftAwareListener.Update update)

Description copied from interface: ShiftAwareListener

Creates a notification for the table changes.

Specified by:

getNotification in interface ShiftAwareListener

Parameters:

update - The set of upstream table updates.

Returns:

table change notification

destroy

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

subscribeForUpdates

public void subscribeForUpdates()

Description copied from class: SwapListenerBase

Invoke DynamicTable.listenForUpdates(Listener) for the appropriate subclass of SwapListenerBase.

Specified by:

subscribeForUpdates in class SwapListenerBase<ShiftAwareListener>

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