1 /*
2 * junixsocket
3 *
4 * Copyright 2009-2024 Christian Kohlschütter
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.newsclub.net.unix;
19
20 import java.io.IOException;
21 import java.nio.channels.DatagramChannel;
22 import java.nio.channels.InterruptibleChannel;
23 import java.nio.channels.SelectableChannel;
24 import java.nio.channels.ServerSocketChannel;
25 import java.nio.channels.SocketChannel;
26
27 /**
28 * Marker interface that combines junixsocket-based {@link SocketChannel}s, {@link DatagramChannel}s
29 * or {@link ServerSocketChannel}s.
30 *
31 * @author Christian Kohlschütter
32 * @see AFSocketChannel
33 * @see AFServerSocketChannel
34 * @see AFDatagramChannel
35 */
36 public interface AFSomeSocketChannel extends InterruptibleChannel, FileDescriptorAccess,
37 AFSomeSocketThing {
38 /**
39 * Checks if the channel is configured blocking. The result may be cached, and therefore not
40 * invoke native code to check if the underlying socket is actually configured that way.
41 *
42 * @return {@code true} if blocking.
43 */
44 boolean isBlocking();
45
46 /**
47 * Adjusts this channel's blocking mode.
48 *
49 * <p>
50 * If the given blocking mode is different from the currently cached blocking mode then this
51 * method native code to change it.
52 * </p>
53 *
54 * @param block {@code true} if blocking is desired.
55 * @return This channel.
56 * @throws IOException on error.
57 */
58 SelectableChannel configureBlocking(boolean block) throws IOException;
59 }