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.pool;
17
18 import io.netty5.buffer.api.BufferAllocator;
19
20 import java.util.List;
21
22 public interface BufferAllocatorMetric {
23
24 /**
25 * Return the number of arenas.
26 */
27 int numArenas();
28
29 /**
30 * Return a {@link List} of all {@link PoolArenaMetric}s that are provided by this pool.
31 */
32 List<PoolArenaMetric> arenaMetrics();
33
34 /**
35 * Return the number of thread local caches used by this {@link PooledBufferAllocator}.
36 */
37 int numThreadLocalCaches();
38
39 /**
40 * Return the size of the small cache.
41 */
42 int smallCacheSize();
43
44 /**
45 * Return the size of the normal cache.
46 */
47 int normalCacheSize();
48
49 /**
50 * Return the chunk size for an arena.
51 */
52 int chunkSize();
53
54 /**
55 * Returns the number of bytes of heap memory used by a {@link BufferAllocator} or {@code -1} if unknown.
56 */
57 long usedMemory();
58
59 /**
60 * Returns the number of bytes of memory that is currently pinned to the buffers allocated by a
61 * {@link BufferAllocator}, or {@code -1} if unknown.
62 */
63 long pinnedMemory();
64 }