net.openhft.chronicle.core.scoped

Class ScopedThreadLocal<T>

java.lang.Object

net.openhft.chronicle.core.scoped.ScopedThreadLocal<T>

All Implemented Interfaces:

ScopedResourcePool<T>

public class ScopedThreadLocal<T>
extends Object
implements ScopedResourcePool<T>

A thread-local ScopedResourcePool.

This is used for small, tightly-scoped thread-local resource "pools", a safer alternative to a thread-local singleton.

Holds a limited-depth stack of instances local to each thread, which are allocated as acquired and returned to the stack as the scopes close. If too many are acquired, a warning is logged and the extra instances are made eligible for garbage collection.

Constructor Summary

Constructors

Constructor and Description
ScopedThreadLocal(@NotNull Supplier<T> supplier, @NotNull Consumer<T> onAcquire, int maxInstances) Constructor
ScopedThreadLocal(@NotNull Supplier<T> supplier, @NotNull Consumer<T> onAcquire, int maxInstances, boolean useWeakReferences) Constructor
ScopedThreadLocal(Supplier<T> supplier, int maxInstances) Constructor

Method Summary

Modifier and Type	Method and Description
ScopedResource<T>	get() Get a scoped instance of the shared resource

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopedThreadLocal

public ScopedThreadLocal(Supplier<T> supplier,
                         int maxInstances)

Constructor

Parameters:

supplier - The supplier of new instances

maxInstances - The maximum number of instances that will be retained for re-use

ScopedThreadLocal

public ScopedThreadLocal(@NotNull
                         @NotNull Supplier<T> supplier,
                         @NotNull
                         @NotNull Consumer<T> onAcquire,
                         int maxInstances)

Constructor

Parameters:

supplier - The supplier of new instances

onAcquire - A function to run on each instance upon it's acquisition

maxInstances - The maximum number of instances that will be retained for re-use

ScopedThreadLocal

public ScopedThreadLocal(@NotNull
                         @NotNull Supplier<T> supplier,
                         @NotNull
                         @NotNull Consumer<T> onAcquire,
                         int maxInstances,
                         boolean useWeakReferences)

Constructor

Parameters:

supplier - The supplier of new instances

onAcquire - A function to run on each instance upon it's acquisition

maxInstances - The maximum number of instances that will be retained for re-use

useWeakReferences - Whether to allow resources to be garbage collected when they're not in use

Method Detail

get

public ScopedResource<T> get()

Get a scoped instance of the shared resource

Specified by:

get in interface ScopedResourcePool<T>

Returns:

the ScopedResource, to be closed once it is finished being used