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 /**
19 * Metrics for a chunk.
20 */
21 public interface PoolChunkMetric {
22
23 /**
24 * Return the percentage of the current usage of the chunk.
25 */
26 int usage();
27
28 /**
29 * Return the size of the chunk in bytes, this is the maximum of bytes that can be served out of the chunk.
30 */
31 int chunkSize();
32
33 /**
34 * Return the number of free bytes in the chunk.
35 */
36 int freeBytes();
37
38 /**
39 * Return the number of pinned bytes in the chunk.
40 */
41 int pinnedBytes();
42 }