ga.strikepractice.stats

Class PlayerStats.CachedStatistic<T>

java.lang.Object

ga.strikepractice.stats.PlayerStats.CachedStatistic<T>

Enclosing interface:

PlayerStats

public abstract static class PlayerStats.CachedStatistic<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected T	cached
protected java.util.function.Supplier<T>	fetcher
protected long	lastUpdateStarted

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CachedStatistic(java.util.function.Supplier<T> fetcher)

Method Summary

Modifier and Type	Method and Description
T	getAndRequestUpdate()
T	getAndRequestUpdate(long maxCacheAge)
T	getCached() Get the cached value
T	getCachedOrRequest() The cached value, querying the database only if there is nothing cached at all.
long	getLastUpdate() Deprecated.
long	getLastUpdateStarted()
void	invalidateCache()
void	requestUpdate(@Nullable java.util.function.Consumer<T> callback)
void	requestUpdate(@Nullable java.util.function.Consumer<T> callback, long maxCacheAgeMs) Request an asynchronous update.
protected void	setCached(T cached) Update the cached value
static void	shutdown() Stops the query threads and waits for the queries still running.

Methods inherited from class java.lang.Object

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

Field Detail

lastUpdateStarted

protected volatile long lastUpdateStarted

cached

protected volatile T cached

fetcher

protected java.util.function.Supplier<T> fetcher

Constructor Detail

CachedStatistic

protected CachedStatistic(java.util.function.Supplier<T> fetcher)

Method Detail

shutdown

public static void shutdown()

Stops the query threads and waits for the queries still running. Called when the plugin disables, right before the connection pool is closed: anything still queued would only run into the closed pool, and closing the pool under a running query aborts its connection, which Hikari logs as a broken connection with a full stack trace.

getCached

public T getCached()

Get the cached value

Returns:

cached value or null if none yet

getCachedOrRequest

public T getCachedOrRequest()

The cached value, querying the database only if there is nothing cached at all.

This is what reads such as placeholders should use. The values are filled in when the player joins and refreshed by PlayerStats.refreshQueriedStats(BattleKit) every time a fight of theirs is saved, so displaying one does not need a query of its own. The fallback covers what those two do not, such as a kit created while the server is running or an earlier query that failed; the cache age keeps it to one attempt per 'cached-stats-max-age' instead of one per read.

Returns:

the cached value, or null if there is none yet

getAndRequestUpdate

public T getAndRequestUpdate(long maxCacheAge)

getAndRequestUpdate

public T getAndRequestUpdate()

setCached

protected void setCached(T cached)

Update the cached value

invalidateCache

public void invalidateCache()

getLastUpdateStarted

public long getLastUpdateStarted()

getLastUpdate

@Deprecated
public long getLastUpdate()

Deprecated.

requestUpdate

public void requestUpdate(@Nullable
                          @Nullable java.util.function.Consumer<T> callback,
                          long maxCacheAgeMs)

Request an asynchronous update. Usually a DB query or something similar. Note: it's possible this never calls the callback.

requestUpdate

public void requestUpdate(@Nullable
                          @Nullable java.util.function.Consumer<T> callback)