1 /*
2 * Copyright 2021 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;
17
18 import io.netty5.util.internal.UnstableApi;
19
20 /**
21 * Methods for accessing and controlling the internals of an allocator.
22 * This interface is intended to be used by implementors of the {@link BufferAllocator}, {@link Buffer} and
23 * {@link MemoryManager} interfaces.
24 *
25 * @apiNote This interface is public because it is a necessary integration point to separate allocators from concrete
26 * buffer implementations. The API is {@linkplain UnstableApi unstable} because Netty's own allocators are the primary
27 * customer of this API, and backwards compatibility at this level should not prevent us from evolving it.
28 */
29 @UnstableApi
30 public interface AllocatorControl {
31 /**
32 * Get the {@link BufferAllocator} instance that is the source of this allocator control.
33 *
34 * @return The {@link BufferAllocator} controlled by this {@link AllocatorControl}.
35 */
36 BufferAllocator getAllocator();
37 }