1 /* 2 * Copyright 2013 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 17 package io.netty.util; 18 19 /** 20 * @deprecated please use {@link ResourceLeakTracker} as it may lead to false-positives. 21 */ 22 @Deprecated 23 public interface ResourceLeak { 24 /** 25 * Records the caller's current stack trace so that the {@link ResourceLeakDetector} can tell where the leaked 26 * resource was accessed lastly. This method is a shortcut to {@link #record(Object) record(null)}. 27 */ 28 void record(); 29 30 /** 31 * Records the caller's current stack trace and the specified additional arbitrary information 32 * so that the {@link ResourceLeakDetector} can tell where the leaked resource was accessed lastly. 33 */ 34 void record(Object hint); 35 36 /** 37 * Close the leak so that {@link ResourceLeakDetector} does not warn about leaked resources. 38 * 39 * @return {@code true} if called first time, {@code false} if called already 40 */ 41 boolean close(); 42 }