core/org.gnit.lucenekmp.search/ReferenceManager

ReferenceManager

abstract class ReferenceManager<G> : AutoCloseable

Utility class to safely share instances of a certain type across multiple threads, while periodically refreshing them. This class ensures each reference is closed only once all threads have finished using it. It is recommended to consult the documentation of ReferenceManager implementations for their maybeRefresh semantics.

Type Parameters

the concrete type that will be acquire acquired and release released.

Inheritors

ReaderManager

SearcherManager

Constructors

ReferenceManager

constructor()

Types

Companion

object Companion

RefreshListener

interface RefreshListener

Functions

acquire

fun acquire(): G

Obtain the current reference. You must match every call to acquire with one call to release; it's best to do so in a finally clause, and set the reference to null to prevent accidental usage after it has been released.

addListener

fun addListener(listener: ReferenceManager.RefreshListener)

Adds a listener, to be notified when a reference is refreshed/swapped.

open override fun close()

Closes this ReferenceManager to prevent future acquire acquiring. A reference manager should be closed if the reference to the managed resource should be disposed or the application using the ReferenceManager is shutting down. The managed resource might not be released immediately, if the ReferenceManager user is holding on to a previously acquire acquired reference. The resource will be released once when the last reference is release released. Those references can still be used as if the manager was still active.

maybeRefresh

fun maybeRefresh(): Boolean

You must call this (or maybeRefreshBlocking), periodically, if you want that will return refreshed instances.

maybeRefreshBlocking

fun maybeRefreshBlocking()

You must call this (or maybeRefresh), periodically, if you want that will return refreshed instances.

release

fun release(reference: G)

Release the reference previously obtained via acquire.

removeListener

fun removeListener(listener: ReferenceManager.RefreshListener)

Removes a listener added by addListener.