NioChannelOption Class — netty Architecture
Architecture documentation for the NioChannelOption class in NioChannelOption.java from the netty codebase.
Entity Profile
Dependency Diagram
graph TD 5e76b03b_2ef8_0a9c_1166_be79b066b796["NioChannelOption"] 9314d714_bf9b_5819_894d_1fddbe7cb3a6["NioChannelOption.java"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|defined in| 9314d714_bf9b_5819_894d_1fddbe7cb3a6 0109bc40_f09d_0582_ea32_64f68b7f7356["NioChannelOption()"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|method| 0109bc40_f09d_0582_ea32_64f68b7f7356 c9358a29_04ac_7923_8c72_af2526b78144["of()"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|method| c9358a29_04ac_7923_8c72_af2526b78144 1bbf3b43_e2cc_3eec_cd19_3396f96358d1["setOption()"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|method| 1bbf3b43_e2cc_3eec_cd19_3396f96358d1 7d28e9cc_35e7_b03e_bd84_54db988ed37a["T()"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|method| 7d28e9cc_35e7_b03e_bd84_54db988ed37a 527e22c8_8275_833c_6a91_1edf1fddd32c["getOptions()"] 5e76b03b_2ef8_0a9c_1166_be79b066b796 -->|method| 527e22c8_8275_833c_6a91_1edf1fddd32c
Relationship Graph
Source Code
transport/src/main/java/io/netty/channel/socket/nio/NioChannelOption.java lines 35–115
public final class NioChannelOption<T> extends ChannelOption<T> {
private final SocketOption<T> option;
@SuppressWarnings("deprecation")
private NioChannelOption(SocketOption<T> option) {
super(option.name());
this.option = option;
}
/**
* Returns a {@link ChannelOption} for the given {@link java.net.SocketOption}.
*/
public static <T> ChannelOption<T> of(SocketOption<T> option) {
return new NioChannelOption<T>(option);
}
// Internal helper methods to remove code duplication between Nio*Channel implementations.
static <T> boolean setOption(Channel jdkChannel, NioChannelOption<T> option, T value) {
NetworkChannel channel = (NetworkChannel) jdkChannel;
if (!channel.supportedOptions().contains(option.option)) {
return false;
}
if (channel instanceof ServerSocketChannel && option.option == StandardSocketOptions.IP_TOS) {
// Skip IP_TOS as a workaround for a JDK bug:
// See https://mail.openjdk.java.net/pipermail/nio-dev/2018-August/005365.html
return false;
}
try {
channel.setOption(option.option, value);
return true;
} catch (IOException e) {
throw new ChannelException(e);
}
}
static <T> T getOption(Channel jdkChannel, NioChannelOption<T> option) {
NetworkChannel channel = (NetworkChannel) jdkChannel;
if (!channel.supportedOptions().contains(option.option)) {
return null;
}
if (channel instanceof ServerSocketChannel && option.option == StandardSocketOptions.IP_TOS) {
// Skip IP_TOS as a workaround for a JDK bug:
// See https://mail.openjdk.java.net/pipermail/nio-dev/2018-August/005365.html
return null;
}
try {
return channel.getOption(option.option);
} catch (IOException e) {
throw new ChannelException(e);
}
}
@SuppressWarnings("unchecked")
static ChannelOption<?>[] getOptions(Channel jdkChannel) {
NetworkChannel channel = (NetworkChannel) jdkChannel;
Set<SocketOption<?>> supportedOpts = channel.supportedOptions();
if (channel instanceof ServerSocketChannel) {
List<ChannelOption<?>> extraOpts = new ArrayList<ChannelOption<?>>(supportedOpts.size());
for (SocketOption<?> opt : supportedOpts) {
if (opt == StandardSocketOptions.IP_TOS) {
// Skip IP_TOS as a workaround for a JDK bug:
// See https://mail.openjdk.java.net/pipermail/nio-dev/2018-August/005365.html
continue;
}
extraOpts.add(new NioChannelOption(opt));
}
return extraOpts.toArray(new ChannelOption[0]);
} else {
ChannelOption<?>[] extraOpts = new ChannelOption[supportedOpts.size()];
int i = 0;
for (SocketOption<?> opt : supportedOpts) {
extraOpts[i++] = new NioChannelOption(opt);
}
return extraOpts;
}
}
}
Source
Frequently Asked Questions
What is the NioChannelOption class?
NioChannelOption is a class in the netty codebase, defined in transport/src/main/java/io/netty/channel/socket/nio/NioChannelOption.java.
Where is NioChannelOption defined?
NioChannelOption is defined in transport/src/main/java/io/netty/channel/socket/nio/NioChannelOption.java at line 35.
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free