Class ResourceLeakDetector<T>

java.lang.Object

io.netty.util.ResourceLeakDetector<T>

Direct Known Subclasses:

LeakPresenceDetector

public class ResourceLeakDetector<T>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ResourceLeakDetector.DefaultResourceLeak<T>
static interface	ResourceLeakDetector.LeakListener
static enum	ResourceLeakDetector.Level	Represents the level of resource leak detection.
private static class	ResourceLeakDetector.TraceRecord

Field Summary

Fields

Modifier and Type	Field	Description
private final java.util.Set<ResourceLeakDetector.DefaultResourceLeak<?>>	allLeaks	the collection of active resources
private static final ResourceLeakDetector.Level	DEFAULT_LEVEL
private static final int	DEFAULT_SAMPLING_INTERVAL
private static final int	DEFAULT_TARGET_RECORDS
private static final boolean	DEFAULT_TRACK_CLOSE
private static final java.util.concurrent.atomic.AtomicReference<java.lang.String[]>	excludedMethods
private ResourceLeakDetector.LeakListener	leakListener	Will be notified once a leak is detected.
private static ResourceLeakDetector.Level	level
private static final InternalLogger	logger
private static final java.lang.String	PROP_LEVEL
private static final java.lang.String	PROP_LEVEL_OLD
private static final java.lang.String	PROP_SAMPLING_INTERVAL
private static final java.lang.String	PROP_TARGET_RECORDS
private static final java.lang.String	PROP_TRACK_CLOSE
private final java.lang.ref.ReferenceQueue<java.lang.Object>	refQueue
private final java.util.Set<java.lang.String>	reportedLeaks
private final java.lang.String	resourceType
(package private) static final int	SAMPLING_INTERVAL
private final int	samplingInterval
private static final int	TARGET_RECORDS
private static final boolean	TRACK_CLOSE

Constructor Summary

Constructors

Constructor	Description
ResourceLeakDetector(java.lang.Class<?> resourceType)	Deprecated. use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).
ResourceLeakDetector(java.lang.Class<?> resourceType, int samplingInterval)	This should not be used directly by users of ResourceLeakDetector.
ResourceLeakDetector(java.lang.Class<?> resourceType, int samplingInterval, long maxActive)	Deprecated. Use ResourceLeakDetector(Class, int).
ResourceLeakDetector(java.lang.String resourceType)	Deprecated. use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).
ResourceLeakDetector(java.lang.String resourceType, int samplingInterval, long maxActive)	Deprecated. use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).

Method Summary

Modifier and Type	Method	Description
static void	addExclusions(java.lang.Class clz, java.lang.String... methodNames)
private void	clearRefQueue()
protected java.lang.Object	getInitialHint(java.lang.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.
boolean	isRecordEnabled()	Check whether ResourceLeakTracker.record() does anything for this detector.
protected boolean	needReport()	When the return value is true, reportTracedLeak(String, String) and reportUntracedLeak(String) will be called once a leak is detected, otherwise not.
final ResourceLeak	open(T obj)	Deprecated. use track(Object)
protected void	reportInstancesLeak(java.lang.String resourceType)	Deprecated. This method will no longer be invoked by ResourceLeakDetector.
private void	reportLeak()
protected void	reportTracedLeak(java.lang.String resourceType, java.lang.String records)	This method is called when a traced leak is detected.
protected void	reportUntracedLeak(java.lang.String resourceType)	This method is called when an untraced leak is detected.
static void	setEnabled(boolean enabled)	Deprecated. Use setLevel(Level) instead.
void	setLeakListener(ResourceLeakDetector.LeakListener leakListener)	Set leak listener.
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.
private ResourceLeakDetector.DefaultResourceLeak<T>	track0(T obj, boolean force)
ResourceLeakTracker<T>	trackForcibly(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

Field Details

PROP_LEVEL_OLD

private static final java.lang.String PROP_LEVEL_OLD

See Also:

• Constant Field Values

PROP_LEVEL

private static final java.lang.String PROP_LEVEL

See Also:

• Constant Field Values

DEFAULT_LEVEL

private static final ResourceLeakDetector.Level DEFAULT_LEVEL

PROP_TARGET_RECORDS

private static final java.lang.String PROP_TARGET_RECORDS

See Also:

• Constant Field Values

DEFAULT_TARGET_RECORDS

private static final int DEFAULT_TARGET_RECORDS

See Also:

• Constant Field Values

PROP_SAMPLING_INTERVAL

private static final java.lang.String PROP_SAMPLING_INTERVAL

See Also:

• Constant Field Values

DEFAULT_SAMPLING_INTERVAL

private static final int DEFAULT_SAMPLING_INTERVAL

See Also:

• Constant Field Values

PROP_TRACK_CLOSE

private static final java.lang.String PROP_TRACK_CLOSE

See Also:

• Constant Field Values

DEFAULT_TRACK_CLOSE

private static final boolean DEFAULT_TRACK_CLOSE

See Also:

• Constant Field Values

TARGET_RECORDS

private static final int TARGET_RECORDS

SAMPLING_INTERVAL

static final int SAMPLING_INTERVAL

TRACK_CLOSE

private static final boolean TRACK_CLOSE

level

private static ResourceLeakDetector.Level level

logger

private static final InternalLogger logger

allLeaks

private final java.util.Set<ResourceLeakDetector.DefaultResourceLeak<?>> allLeaks

the collection of active resources

refQueue

private final java.lang.ref.ReferenceQueue<java.lang.Object> refQueue

reportedLeaks

private final java.util.Set<java.lang.String> reportedLeaks

resourceType

private final java.lang.String resourceType

samplingInterval

private final int samplingInterval

leakListener

private volatile ResourceLeakDetector.LeakListener leakListener

Will be notified once a leak is detected.

excludedMethods

private static final java.util.concurrent.atomic.AtomicReference<java.lang.String[]> excludedMethods

Constructor Details

ResourceLeakDetector

@Deprecated
public ResourceLeakDetector(java.lang.Class<?> resourceType)

Deprecated.

use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).

ResourceLeakDetector

@Deprecated
public ResourceLeakDetector(java.lang.String resourceType)

Deprecated.

use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).

ResourceLeakDetector

@Deprecated
public ResourceLeakDetector(java.lang.Class<?> resourceType,
 int samplingInterval,
 long maxActive)

Deprecated.

Use ResourceLeakDetector(Class, int).

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

Parameters:

maxActive - This is deprecated and will be ignored.

ResourceLeakDetector

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

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

ResourceLeakDetector

@Deprecated
public ResourceLeakDetector(java.lang.String resourceType,
 int samplingInterval,
 long maxActive)

Deprecated.

use ResourceLeakDetectorFactory.newResourceLeakDetector(Class, int, long).

Parameters:

maxActive - This is deprecated and will be ignored.

Method Details

setEnabled

@Deprecated
public static void setEnabled(boolean enabled)

Deprecated.

Use setLevel(Level) instead.

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.

open

@Deprecated
public final ResourceLeak open(T obj)

Deprecated.

use track(Object)

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

Returns:

the ResourceLeak or null

track

public 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

trackForcibly

public ResourceLeakTracker<T> trackForcibly(T obj)

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

Unlike track(Object), this method always returns a tracker, regardless of the detection settings.

Returns:

the ResourceLeakTracker

isRecordEnabled

public boolean isRecordEnabled()

Check whether ResourceLeakTracker.record() does anything for this detector.

Returns:

true if ResourceLeakTracker.record() should be called

track0

private ResourceLeakDetector.DefaultResourceLeak<T> track0(T obj,
 boolean force)

clearRefQueue

private void clearRefQueue()

needReport

protected boolean needReport()

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

Returns:

true to enable leak reporting.

reportLeak

private void reportLeak()

reportTracedLeak

protected void reportTracedLeak(java.lang.String resourceType,
 java.lang.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(java.lang.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(java.lang.String resourceType)

Deprecated.

This method will no longer be invoked by ResourceLeakDetector.

getInitialHint

protected java.lang.Object getInitialHint(java.lang.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.

setLeakListener

public void setLeakListener(ResourceLeakDetector.LeakListener leakListener)

Set leak listener. Previous listener will be replaced.

addExclusions

public static void addExclusions(java.lang.Class clz,
 java.lang.String... methodNames)