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.internal;
17
18 import io.netty5.buffer.api.ReadableComponent;
19
20 import java.nio.ByteBuffer;
21
22 /**
23 * Safety by-pass that let us get {@link java.nio.ByteBuffer}s from a {@link io.netty5.buffer.api.ReadableComponent}
24 * that is not read-only.
25 * <p>
26 * This is for instance used by the {@code SslHandler}, because some {@link javax.net.ssl.SSLEngine} implementations
27 * cannot unwrap or decode packets from read-only buffers.
28 */
29 public interface NotReadOnlyReadableComponent {
30 /**
31 * Get a {@link ByteBuffer} instance for this memory component.
32 * <p>
33 * <strong>Note</strong> that unlike the {@link ReadableComponent#readableBuffer()} method, the {@link ByteBuffer}
34 * returned here is writable.
35 *
36 * @return A new {@link ByteBuffer}, with its own position and limit, for this memory component.
37 */
38 ByteBuffer mutableReadableBuffer();
39 }