View Javadoc
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.channel.nio;
17  
18  import java.nio.channels.ClosedChannelException;
19  import java.nio.channels.SelectionKey;
20  import java.nio.channels.Selector;
21  
22  
23  /**
24   * Process IO.
25   */
26  interface NioProcessor {
27  
28      /**
29       * Register to a {@link Selector}.
30       *
31       * @param selector                  the {@link Selector} to register to.
32       * @throws ClosedChannelException   if already closed.
33       */
34      void register(Selector selector) throws ClosedChannelException;
35  
36      /**
37       * Deregister from previous registered {@link Selector}.
38       */
39      void deregister();
40  
41      /**
42       * Handle some IO for the given {@link SelectionKey}.
43       *
44       * @param key   the {@link SelectionKey} that needs to be handled.
45       */
46      void handle(SelectionKey key);
47  
48      /**
49       * Close this processor.
50       */
51      void close();
52  }