1 /*
2 * Copyright 2016 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.util;
17
18 import org.jetbrains.annotations.Nullable;
19
20 public interface ResourceLeakTracker<T> {
21
22 /**
23 * Records the caller's current stack trace so that the {@link ResourceLeakDetector} can tell where the leaked
24 * resource was accessed lastly. This method is a shortcut to {@link #record(Object) record(null)}.
25 */
26 void record();
27
28 /**
29 * Records the caller's current stack trace and the specified additional arbitrary information
30 * so that the {@link ResourceLeakDetector} can tell where the leaked resource was accessed lastly.
31 */
32 void record(Object hint);
33
34 /**
35 * Close the leak so that {@link ResourceLeakTracker} does not warn about leaked resources.
36 * After this method is called a leak associated with this ResourceLeakTracker should not be reported.
37 *
38 * @return {@code true} if called first time, {@code false} if called already
39 */
40 boolean close(T trackedObject);
41
42 /**
43 * Get a {@link Throwable} representing the stack trace of the original {@link #close(Object)} call.
44 * If this tracker hasn't been cloesd, or close tracking isn't supported or enabled,
45 * then this method returns {@code null}.
46 *
47 * @return A throwable with the stack trace of the successful close call, or {@code null}.
48 */
49 default @Nullable Throwable getCloseStackTraceIfAny() {
50 return null;
51 }
52 }