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.handler.ssl;
17
18 import javax.net.ssl.SSLEngineResult;
19 import javax.net.ssl.SSLException;
20 import java.nio.ByteBuffer;
21
22 /**
23 * Optional extra interface that {@link javax.net.ssl.SSLEngine} sub-classes can implement, if they support a faster
24 * way of unwrapping multiple input buffers into multiple output buffers.
25 */
26 interface VectoredUnwrap {
27 /**
28 * Similar to {@link javax.net.ssl.SSLEngine#unwrap(ByteBuffer, ByteBuffer[])}, but takes an array of input buffers.
29 *
30 * @param srcs The array of source buffers with data to unwrap.
31 * @param dsts The array of destination buffers where the unwrapped data should be written.
32 * @return The {@link SSLEngineResult} of the unwrap operation.
33 * @throws SSLException A problem was encountered during data processing that caused the
34 * {@link javax.net.ssl.SSLEngine} to abort.
35 * @see javax.net.ssl.SSLEngine#unwrap(ByteBuffer, ByteBuffer[])
36 */
37 SSLEngineResult unwrap(ByteBuffer[] srcs, ByteBuffer[] dsts) throws SSLException;
38 }