net.openhft.chronicle.core.threads

Class CleaningThread

java.lang.Object

java.lang.Thread

net.openhft.chronicle.core.threads.CleaningThread

All Implemented Interfaces:

Runnable

public class CleaningThread
extends Thread

The CleaningThread class extends the Thread class and provides functionality to clean up thread-local variables when the thread completes its execution. It is particularly useful for avoiding memory leaks associated with thread-local variables.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CleaningThread(Runnable target) Constructs a new CleaningThread with the specified target Runnable.
CleaningThread(Runnable target, String name) Constructs a new CleaningThread with the specified target Runnable and name.
CleaningThread(Runnable target, String name, boolean inEventLoop) Constructs a new CleaningThread with the specified target Runnable, name, and inEventLoop flag.

Method Summary

Modifier and Type	Method and Description
boolean	inEventLoop() Returns the inEventLoop flag, indicating whether this thread is in an event loop.
static boolean	inEventLoop(Thread t) Checks if the given thread is an instance of CleaningThread and if it is in an event loop.
static void	performCleanup(Thread thread) Cleans up any CleaningThreadLocal associated with the given thread.
static void	performCleanup(Thread thread, CleaningThreadLocal<?> ctl) Cleans up a specific CleaningThreadLocal instance associated with the given thread.
void	run() Overrides the run method to reset the thread affinity, execute the target runnable and then perform clean up of thread locals.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

CleaningThread

public CleaningThread(Runnable target)

Constructs a new CleaningThread with the specified target Runnable.

Parameters:

target - The Runnable object to execute in the new thread.

CleaningThread

public CleaningThread(Runnable target,
                      String name)

Constructs a new CleaningThread with the specified target Runnable and name.

Parameters:

target - The Runnable object to execute in the new thread.

name - The name for the new thread.

CleaningThread

public CleaningThread(Runnable target,
                      String name,
                      boolean inEventLoop)

Constructs a new CleaningThread with the specified target Runnable, name, and inEventLoop flag.

Parameters:

target - The Runnable object to execute in the new thread.

name - The name for the new thread.

inEventLoop - The flag indicating whether the thread is in an event loop.

Method Detail

performCleanup

public static void performCleanup(Thread thread)

Cleans up any CleaningThreadLocal associated with the given thread. This method uses reflection to find the thread locals for a thread and navigates through a WeakReference to get to its destination. Note that if a garbage collection has occurred, this method may not be able to clean up effectively.

Parameters:

thread - The thread whose CleaningThreadLocal instances are to be cleaned up.

performCleanup

public static void performCleanup(Thread thread,
                                  CleaningThreadLocal<?> ctl)

Cleans up a specific CleaningThreadLocal instance associated with the given thread.

Parameters:

thread - The thread whose specific CleaningThreadLocal instance is to be cleaned up.

ctl - The specific CleaningThreadLocal instance to clean up. If null, cleans all.

inEventLoop

public static boolean inEventLoop(Thread t)

Checks if the given thread is an instance of CleaningThread and if it is in an event loop.

Parameters:

t - The thread to check.

Returns:

true if the thread is an instance of CleaningThread and in an event loop, false otherwise.

run

public void run()

Overrides the run method to reset the thread affinity, execute the target runnable and then perform clean up of thread locals.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

inEventLoop

public boolean inEventLoop()

Returns the inEventLoop flag, indicating whether this thread is in an event loop.

Returns:

true if this thread is in an event loop, false otherwise.