1 /*
2 * Copyright 2024 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.netty.channel.uring;
17
18 import io.netty.channel.IoOps;
19 import io.netty.channel.IoRegistration;
20
21 /**
22 * {@link IoRegistration} to use with io_uring.
23 */
24 public interface IoUringIoRegistration extends IoRegistration {
25
26 /**
27 * Submit a {@link IoUringIoOps} that will produce an entry on the used submission queue.
28 *
29 * @param ops ops.
30 * @return the u_data of the {@link IoUringIoOps}. This can be used to cancel a previous submitted
31 * {@link IoUringIoOps}. If submission failed as the registration is not valid anymore this method will return
32 * {@code 0}.
33 */
34 @Override
35 long submit(IoOps ops);
36
37 @Override
38 void cancel();
39 }