1 /*
2 * Copyright 2022 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.netty5.buffer.api.pool;
17
18 import io.netty5.buffer.api.Buffer;
19 import io.netty5.buffer.api.Drop;
20
21 /**
22 * Memory that isn't attached to any particular buffer.
23 * <p>
24 * Used for transporting the details of a buffer allocation through the layers in {@link PooledBufferAllocator}.
25 */
26 public interface UntetheredMemory {
27 /**
28 * Produces the recoverable memory object associated with this piece of untethered memory.
29 *
30 * @implNote This method should only be called once, since it might be expensive.
31 */
32 <Memory> Memory memory();
33
34 /**
35 * Produces the drop instance associated with this piece of untethered memory.
36 *
37 * @implNote This method should only be called once, since it might be expensive, or interact with Cleaners.
38 */
39 <BufferType extends Buffer> Drop<BufferType> drop();
40 }