net.openhft.chronicle.core.io

Class BackgroundResourceReleaser

java.lang.Object

net.openhft.chronicle.core.io.BackgroundResourceReleaser

public final class BackgroundResourceReleaser
extends Object

Performs close and release operations on a background thread.

Closing in the background reduces worst case pause times because the caller does not have to perform the tidy up work. The behaviour is controlled by two system properties:

• background.releaser — set to false to disable queuing and release resources on the caller's thread.
• background.releaser.thread — set to false to queue work but require manual calls to releasePendingResources().

Example usage:

 MyCloseable closeable = new MyCloseable();
 BackgroundResourceReleaser.release(closeable);
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKGROUND_RESOURCE_RELEASER

Method Summary

Modifier and Type	Method and Description
static boolean	isOnBackgroundResourceReleaserThread() Checks if the current thread is the background resource releaser thread.
static void	release(AbstractCloseable closeable) Releases the specified closeable resource.
static void	release(AbstractReferenceCounted referenceCounted) Releases the specified reference counted resource.
static void	releasePendingResources() Releases all pending resources.
static void	run(Runnable runnable) Executes the specified runnable to release the resource.
static void	stop() Stops the background releasing thread after releasing pending resources.

Methods inherited from class java.lang.Object

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

Field Detail

BACKGROUND_RESOURCE_RELEASER

public static final String BACKGROUND_RESOURCE_RELEASER

See Also:

Constant Field Values

Method Detail

stop

public static void stop()

Stops the background releasing thread after releasing pending resources.

It should be called during the shutdown process to release any resources that have not been released yet.

release

public static void release(AbstractCloseable closeable)

Releases the specified closeable resource.

Parameters:

closeable - the resource to release

release

public static void release(AbstractReferenceCounted referenceCounted)

Releases the specified reference counted resource.

Parameters:

referenceCounted - the resource to release

run

public static void run(Runnable runnable)

Executes the specified runnable to release the resource.

Parameters:

runnable - the runnable to execute for releasing the resource

releasePendingResources

public static void releasePendingResources()

Releases all pending resources.

Should be called when you want to make sure that all the resources that have been queued for release are actually released.

isOnBackgroundResourceReleaserThread

public static boolean isOnBackgroundResourceReleaserThread()

Checks if the current thread is the background resource releaser thread.

Returns:

true if the current thread is the background resource releaser thread; false otherwise.