com.illumon.iris.db.tables.live

Class LiveTableRefreshCombiner

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

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

com.illumon.iris.db.tables.live.LiveTableRefreshCombiner

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, LiveTable, LiveTableRegistrar, LivenessManager, LivenessNode, LivenessReferent, Serializable

public class LiveTableRefreshCombiner
extends LivenessArtifact
implements LiveTable, LiveTableRegistrar

Combines multiple LiveTables into a single one, in order to allow for update parallelization within the LiveTableMonitor.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LiveTableRefreshCombiner()

Method Summary

Modifier and Type	Method and Description
void	addTable(LiveTable liveTable) Add a table to this registrar.
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.
protected void	onReferenceCountAtZero() Callback method that will be invoked when the reference count returns to zero.
void	refresh() Refresh this LiveTable.
void	removeTable(LiveTable liveTable) Remove a table from this registrar.
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

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

getReferentDescription, retainReference

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

manage

Constructor Detail

LiveTableRefreshCombiner

public LiveTableRefreshCombiner()

Method Detail

refresh

public void refresh()

Description copied from interface: LiveTable

Refresh this LiveTable.

Specified by:

refresh in interface LiveTable

addTable

public void addTable(@NotNull
                     LiveTable liveTable)

Description copied from interface: LiveTableRegistrar

Add a table to this registrar.

Specified by:

addTable in interface LiveTableRegistrar

Parameters:

liveTable - The table to add

removeTable

public void removeTable(@NotNull
                        LiveTable liveTable)

Description copied from interface: LiveTableRegistrar

Remove a table from this registrar.

Specified by:

removeTable in interface LiveTableRegistrar

Parameters:

liveTable - The table to remove

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.

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