ResourceLeakTracker Type — netty Architecture

Source Code

common/src/main/java/io/netty/util/ResourceLeakTracker.java lines 20–52

public interface ResourceLeakTracker<T>  {

    /**
     * Records the caller's current stack trace so that the {@link ResourceLeakDetector} can tell where the leaked
     * resource was accessed lastly. This method is a shortcut to {@link #record(Object) record(null)}.
     */
    void record();

    /**
     * Records the caller's current stack trace and the specified additional arbitrary information
     * so that the {@link ResourceLeakDetector} can tell where the leaked resource was accessed lastly.
     */
    void record(Object hint);

    /**
     * Close the leak so that {@link ResourceLeakTracker} does not warn about leaked resources.
     * After this method is called a leak associated with this ResourceLeakTracker should not be reported.
     *
     * @return {@code true} if called first time, {@code false} if called already
     */
    boolean close(T trackedObject);

    /**
     * Get a {@link Throwable} representing the stack trace of the original {@link #close(Object)} call.
     * If this tracker hasn't been cloesd, or close tracking isn't supported or enabled,
     * then this method returns {@code null}.
     *
     * @return A throwable with the stack trace of the successful close call, or {@code null}.
     */
    default @Nullable Throwable getCloseStackTraceIfAny() {
        return null;
    }
}