Module io.netty5.common

Package io.netty5.util

Class ResourceLeakDetector<T>

java.lang.Object

io.netty5.util.ResourceLeakDetector<T>

public class ResourceLeakDetector<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceLeakDetector.Level	Represents the level of resource leak detection.

Constructor Summary

Constructors

Constructor	Description
ResourceLeakDetector(Class<?> resourceType, int samplingInterval)	This should not be used directly by users of ResourceLeakDetector.

Method Summary

Modifier and Type	Method	Description
static void	addExclusions(Class<?> clz, String... methodNames)
protected Object	getInitialHint(String resourceType)	Create a hint object to be attached to an object tracked by this record.
static ResourceLeakDetector.Level	getLevel()	Returns the current resource leak detection level.
static boolean	isEnabled()	Returns true if resource leak detection is enabled.
protected boolean	needReport()	When the return value is true, reportTracedLeak(java.lang.String, java.lang.String) and reportUntracedLeak(java.lang.String) will be called once a leak is detected, otherwise not.
protected void	reportInstancesLeak(String resourceType)	Deprecated. This method will no longer be invoked by ResourceLeakDetector.
protected void	reportTracedLeak(String resourceType, String records)	This method is called when a traced leak is detected.
protected void	reportUntracedLeak(String resourceType)	This method is called when an untraced leak is detected.
static void	setLevel(ResourceLeakDetector.Level level)	Sets the resource leak detection level.
ResourceLeakTracker<T>	track(T obj)	Creates a new ResourceLeakTracker which is expected to be closed via ResourceLeakTracker.close(Object) when the related resource is deallocated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLeakDetector

public ResourceLeakDetector(Class<?> resourceType,
                            int samplingInterval)

This should not be used directly by users of ResourceLeakDetector. Please use ResourceLeakDetectorFactory.newResourceLeakDetector(Class) or ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int)

Method Detail

isEnabled

public static boolean isEnabled()

Returns true if resource leak detection is enabled.

setLevel

public static void setLevel(ResourceLeakDetector.Level level)

Sets the resource leak detection level.

getLevel

public static ResourceLeakDetector.Level getLevel()

Returns the current resource leak detection level.

track

public final ResourceLeakTracker<T> track(T obj)

Creates a new ResourceLeakTracker which is expected to be closed via ResourceLeakTracker.close(Object) when the related resource is deallocated.

Returns:

the ResourceLeakTracker or null

needReport

protected boolean needReport()

When the return value is true, reportTracedLeak(java.lang.String, java.lang.String) and reportUntracedLeak(java.lang.String) will be called once a leak is detected, otherwise not.

Returns:

true to enable leak reporting.

reportTracedLeak

protected void reportTracedLeak(String resourceType,
                                String records)

This method is called when a traced leak is detected. It can be overridden for tracking how many times leaks have been detected.

reportUntracedLeak

protected void reportUntracedLeak(String resourceType)

This method is called when an untraced leak is detected. It can be overridden for tracking how many times leaks have been detected.

reportInstancesLeak

@Deprecated
protected void reportInstancesLeak(String resourceType)

Deprecated.

This method will no longer be invoked by ResourceLeakDetector.

getInitialHint

protected Object getInitialHint(String resourceType)

Create a hint object to be attached to an object tracked by this record. Similar to the additional information supplied to ResourceLeakTracker.record(Object), will be printed alongside the stack trace of the creation of the resource.

addExclusions

public static void addExclusions(Class<?> clz,
                                 String... methodNames)