Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	NioSocketChannel.NioSocketChannelConfig
private class	NioSocketChannel.NioSocketChannelUnsafe

Field Summary

Modifier and Type	Field and Description
private final SocketChannelConfig	config
private static final SelectorProvider	DEFAULT_SELECTOR_PROVIDER
private static final InternalLogger	logger Hides io.netty.channel.nio.AbstractNioChannel.logger.
private static final Method	OPEN_SOCKET_CHANNEL_WITH_FAMILY

Constructor Summary

Access	Constructor and Description
public	NioSocketChannel() Create a new instance
public	NioSocketChannel(SelectorProvider provider) Create a new instance using the given `SelectorProvider`.
public	NioSocketChannel(SelectorProvider provider, InternetProtocolFamily family) Create a new instance using the given `SelectorProvider` and protocol family (supported only since JDK 15).
public	NioSocketChannel(SocketChannel socket) Create a new instance using the given `SocketChannel`.
public	NioSocketChannel(Channel the `Channel` which created this instance or `null` if it was created by the user parent, SocketChannel the `SocketChannel` which will be used socket) Create a new instance

Method Summary

Modifier and Type	Method and Description
private void	adjustMaxBytesPerGatheringWrite(int attempted, int written, int oldMaxBytesPerGatheringWrite)
public SocketChannelConfig	config() Implements io.netty.channel.socket.SocketChannel.config, io.netty.channel.Channel.config. Returns the configuration of this channel.
protected void	doBind(SocketAddress localAddress) Implements abstract io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress`
private void	doBind0(SocketAddress localAddress)
protected void	doClose() Overrides io.netty.channel.nio.AbstractNioChannel.doClose. Close the `Channel`
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Implements abstract io.netty.channel.nio.AbstractNioChannel.doConnect. Connect to the remote peer
protected void	doDisconnect() Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer
protected void	doFinishConnect() Implements abstract io.netty.channel.nio.AbstractNioChannel.doFinishConnect. Finish the connect
protected int	doReadBytes(ByteBuf byteBuf) Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doReadBytes. Read bytes into the given `ByteBuf` and return the amount.
protected final void	doShutdownOutput() Overrides io.netty.channel.AbstractChannel.doShutdownOutput. Called when conditions justify shutting down the output portion of the channel.
protected void	doWrite(ChannelOutboundBuffer in) Overrides io.netty.channel.nio.AbstractNioByteChannel.doWrite. Flush the content of the given buffer to the remote peer.
protected int	doWriteBytes(ByteBuf the `ByteBuf` from which the bytes should be written buf) Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteBytes. Write bytes form the given `ByteBuf` to the underlying `java.nio.channels.Channel`.
protected long	doWriteFileRegion(FileRegion the `FileRegion` from which the bytes should be written region) Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteFileRegion. Write a `FileRegion`
public boolean	isActive() Implements io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected.
public boolean	isInputShutdown() Implements io.netty.channel.socket.DuplexChannel.isInputShutdown. Returns `true` if and only if the remote peer shut down its output so that no more data is received from this channel.
protected boolean	isInputShutdown0() Overrides io.netty.channel.nio.AbstractNioByteChannel.isInputShutdown0.
public boolean	isOutputShutdown() Implements io.netty.channel.socket.DuplexChannel.isOutputShutdown.
public boolean	isShutdown() Implements io.netty.channel.socket.DuplexChannel.isShutdown. Determine if both the input and output of this channel have been shutdown.
protected SocketChannel	javaChannel() Overrides io.netty.channel.nio.AbstractNioChannel.javaChannel.
public InetSocketAddress	localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.socket.SocketChannel.localAddress, io.netty.channel.Channel.localAddress. Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally.
private static SocketChannel	newChannel(SelectorProvider provider, InternetProtocolFamily family)
protected AbstractNioChannel.AbstractNioUnsafe	newUnsafe() Overrides io.netty.channel.nio.AbstractNioByteChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel`
public ServerSocketChannel	parent() Overrides io.netty.channel.AbstractChannel.parent. Implements io.netty.channel.socket.SocketChannel.parent, io.netty.channel.Channel.parent. Returns the parent of this channel.
public InetSocketAddress	remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.socket.SocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to.
public ChannelFuture	shutdown() Implements io.netty.channel.socket.DuplexChannel.shutdown. Will shutdown the input and output sides of this channel.
public ChannelFuture	shutdown(final ChannelPromise will be completed when both shutdown operations complete. promise) Implements io.netty.channel.socket.DuplexChannel.shutdown. Will shutdown the input and output sides of this channel.
private static void	shutdownDone(ChannelFuture shutdownOutputFuture, ChannelFuture shutdownInputFuture, ChannelPromise promise)
public ChannelFuture	shutdownInput() Implements abstract io.netty.channel.nio.AbstractNioByteChannel.shutdownInput. Implements io.netty.channel.socket.DuplexChannel.shutdownInput. Shutdown the input side of the channel.
public ChannelFuture	shutdownInput(final ChannelPromise promise) Implements io.netty.channel.socket.DuplexChannel.shutdownInput. Will shutdown the input and notify `ChannelPromise`.
private void	shutdownInput0(final ChannelPromise promise)
private void	shutdownInput0()
public ChannelFuture	shutdownOutput() Implements io.netty.channel.socket.DuplexChannel.shutdownOutput.
public ChannelFuture	shutdownOutput(final ChannelPromise promise) Implements io.netty.channel.socket.DuplexChannel.shutdownOutput. Will shutdown the output and notify `ChannelPromise`.
private void	shutdownOutputDone(final ChannelFuture shutdownOutputFuture, final ChannelPromise promise)

Inherited from io.netty.channel.nio.AbstractNioByteChannel:: clearOpWrite doWrite0 filterOutboundMessage incompleteWrite metadata setOpWrite

Field Detail

config	back to summary
private final SocketChannelConfig config

DEFAULT_SELECTOR_PROVIDER	back to summary
private static final SelectorProvider DEFAULT_SELECTOR_PROVIDER

logger	back to summary
private static final InternalLogger logger Hides io.netty.channel.nio.AbstractNioChannel.logger.

OPEN_SOCKET_CHANNEL_WITH_FAMILY	back to summary
private static final Method OPEN_SOCKET_CHANNEL_WITH_FAMILY

Constructor Detail

NioSocketChannel	back to summary
public NioSocketChannel() Create a new instance

NioSocketChannel	back to summary
public NioSocketChannel(SelectorProvider provider) Create a new instance using the given `SelectorProvider`.

NioSocketChannel	back to summary
public NioSocketChannel(SelectorProvider provider, InternetProtocolFamily family) Create a new instance using the given `SelectorProvider` and protocol family (supported only since JDK 15).

NioSocketChannel	back to summary
public NioSocketChannel(SocketChannel socket) Create a new instance using the given `SocketChannel`.

NioSocketChannel back to summary

NioSocketChannel	back to summary
public NioSocketChannel(Channel parent, SocketChannel socket) Create a new instance Parameters parent:Channel the `Channel` which created this instance or `null` if it was created by the user socket:SocketChannel the `SocketChannel` which will be used

public NioSocketChannel(Channel parent, SocketChannel socket)

Create a new instance

Parameters

parent:Channel: the Channel which created this instance or null if it was created by the user
socket:SocketChannel: the SocketChannel which will be used

Method Detail

adjustMaxBytesPerGatheringWrite	back to summary
private void adjustMaxBytesPerGatheringWrite(int attempted, int written, int oldMaxBytesPerGatheringWrite)

config	back to summary
public SocketChannelConfig config() Implements io.netty.channel.socket.SocketChannel.config, io.netty.channel.Channel.config. Doc from io.netty.channel.Channel.config. Returns the configuration of this channel. Annotations @Override

config

back to summary

public SocketChannelConfig config()

Implements io.netty.channel.socket.SocketChannel.config, io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations

@Override

doBind back to summary

doBind	back to summary
protected void doBind(SocketAddress localAddress) throws Exception Implements abstract io.netty.channel.AbstractChannel.doBind. Doc from io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress` Annotations @Override

protected void doBind(SocketAddress localAddress) throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBind.

Doc from io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Annotations

@Override

doBind0	back to summary
private void doBind0(SocketAddress localAddress) throws Exception

doClose back to summary

doClose	back to summary
protected void doClose() throws Exception Overrides io.netty.channel.nio.AbstractNioChannel.doClose. Doc from io.netty.channel.AbstractChannel.doClose. Close the `Channel` Annotations @Override

protected void doClose() throws Exception

Overrides io.netty.channel.nio.AbstractNioChannel.doClose.

Doc from io.netty.channel.AbstractChannel.doClose.

Close the Channel

Annotations

@Override

doConnect	back to summary
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception Implements abstract io.netty.channel.nio.AbstractNioChannel.doConnect. Doc from io.netty.channel.nio.AbstractNioChannel.doConnect. Connect to the remote peer Annotations @Override

doConnect

back to summary

protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception

Implements abstract io.netty.channel.nio.AbstractNioChannel.doConnect.

Doc from io.netty.channel.nio.AbstractNioChannel.doConnect.

Connect to the remote peer

Annotations

@Override

doDisconnect back to summary

doDisconnect	back to summary
protected void doDisconnect() throws Exception Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Doc from io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer Annotations @Override

protected void doDisconnect() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doDisconnect.

Doc from io.netty.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer

Annotations

@Override

doFinishConnect	back to summary
protected void doFinishConnect() throws Exception Implements abstract io.netty.channel.nio.AbstractNioChannel.doFinishConnect. Doc from io.netty.channel.nio.AbstractNioChannel.doFinishConnect. Finish the connect Annotations @Override

doFinishConnect

back to summary

protected void doFinishConnect() throws Exception

Implements abstract io.netty.channel.nio.AbstractNioChannel.doFinishConnect.

Doc from io.netty.channel.nio.AbstractNioChannel.doFinishConnect.

Finish the connect

Annotations

@Override

doReadBytes back to summary

doReadBytes	back to summary
protected int doReadBytes(ByteBuf byteBuf) throws Exception Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doReadBytes. Doc from io.netty.channel.nio.AbstractNioByteChannel.doReadBytes. Read bytes into the given `ByteBuf` and return the amount. Annotations @Override

protected int doReadBytes(ByteBuf byteBuf) throws Exception

Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doReadBytes.

Doc from io.netty.channel.nio.AbstractNioByteChannel.doReadBytes.

Read bytes into the given ByteBuf and return the amount.

Annotations

@Override

doShutdownOutput	back to summary
protected final void doShutdownOutput() throws Exception Overrides io.netty.channel.AbstractChannel.doShutdownOutput. Doc from io.netty.channel.AbstractChannel.doShutdownOutput. Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception. Annotations @SuppressJava6Requirement reason:Usage guarded by java version check @UnstableApi @Override

doShutdownOutput

back to summary

protected final void doShutdownOutput() throws Exception

Overrides io.netty.channel.AbstractChannel.doShutdownOutput.

Doc from io.netty.channel.AbstractChannel.doShutdownOutput.

Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.

Annotations

@SuppressJava6Requirement
reason:Usage guarded by java version check
@UnstableApi
@Override

doWrite	back to summary
protected void doWrite(ChannelOutboundBuffer in) throws Exception Overrides io.netty.channel.nio.AbstractNioByteChannel.doWrite. Doc from io.netty.channel.AbstractChannel.doWrite. Flush the content of the given buffer to the remote peer. Annotations @Override

doWrite

back to summary

protected void doWrite(ChannelOutboundBuffer in) throws Exception

Overrides io.netty.channel.nio.AbstractNioByteChannel.doWrite.

Doc from io.netty.channel.AbstractChannel.doWrite.

Flush the content of the given buffer to the remote peer.

Annotations

@Override

doWriteBytes back to summary

doWriteBytes	back to summary
protected int doWriteBytes(ByteBuf buf) throws Exception Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteBytes. Doc from io.netty.channel.nio.AbstractNioByteChannel.doWriteBytes. Write bytes form the given `ByteBuf` to the underlying `java.nio.channels.Channel`. Parameters buf:ByteBuf the `ByteBuf` from which the bytes should be written Returns:int amount the amount of written bytes Annotations @Override

protected int doWriteBytes(ByteBuf buf) throws Exception

Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteBytes.

Doc from io.netty.channel.nio.AbstractNioByteChannel.doWriteBytes.

Write bytes form the given ByteBuf to the underlying java.nio.channels.Channel.

Parameters

buf:ByteBuf: the ByteBuf from which the bytes should be written

Returns:int

amount the amount of written bytes

Annotations

@Override

doWriteFileRegion back to summary

doWriteFileRegion	back to summary
protected long doWriteFileRegion(FileRegion region) throws Exception Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteFileRegion. Doc from io.netty.channel.nio.AbstractNioByteChannel.doWriteFileRegion. Write a `FileRegion` Parameters region:FileRegion the `FileRegion` from which the bytes should be written Returns:long amount the amount of written bytes Annotations @Override

protected long doWriteFileRegion(FileRegion region) throws Exception

Implements abstract io.netty.channel.nio.AbstractNioByteChannel.doWriteFileRegion.

Doc from io.netty.channel.nio.AbstractNioByteChannel.doWriteFileRegion.

Write a FileRegion

Parameters

region:FileRegion: the FileRegion from which the bytes should be written

Returns:long

amount the amount of written bytes

Annotations

@Override

isActive back to summary

isActive	back to summary
public boolean isActive() Implements io.netty.channel.Channel.isActive. Doc from io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected. Annotations @Override

public boolean isActive()

Implements io.netty.channel.Channel.isActive.

Doc from io.netty.channel.Channel.isActive.

Return true if the Channel is active and so connected.

Annotations

@Override

isInputShutdown back to summary

isInputShutdown	back to summary
public boolean isInputShutdown() Implements io.netty.channel.socket.DuplexChannel.isInputShutdown. Doc from io.netty.channel.socket.DuplexChannel.isInputShutdown. Returns `true` if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of `Socket#shutdownInput()` and `Socket#isInputShutdown()`. Annotations @Override

public boolean isInputShutdown()

Implements io.netty.channel.socket.DuplexChannel.isInputShutdown.

Doc from io.netty.channel.socket.DuplexChannel.isInputShutdown.

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket#shutdownInput() and Socket#isInputShutdown().

Annotations

@Override

isInputShutdown0	back to summary
protected boolean isInputShutdown0() Overrides io.netty.channel.nio.AbstractNioByteChannel.isInputShutdown0. Annotations @Override

isInputShutdown0

back to summary

protected boolean isInputShutdown0()

Overrides io.netty.channel.nio.AbstractNioByteChannel.isInputShutdown0.

Annotations

@Override

isOutputShutdown	back to summary
public boolean isOutputShutdown() Implements io.netty.channel.socket.DuplexChannel.isOutputShutdown. Annotations @Override

isOutputShutdown

back to summary

public boolean isOutputShutdown()

Implements io.netty.channel.socket.DuplexChannel.isOutputShutdown.

Annotations

@Override

isShutdown	back to summary
public boolean isShutdown() Implements io.netty.channel.socket.DuplexChannel.isShutdown. Doc from io.netty.channel.socket.DuplexChannel.isShutdown. Determine if both the input and output of this channel have been shutdown. Annotations @Override

isShutdown

back to summary

public boolean isShutdown()

Implements io.netty.channel.socket.DuplexChannel.isShutdown.

Doc from io.netty.channel.socket.DuplexChannel.isShutdown.

Determine if both the input and output of this channel have been shutdown.

Annotations

@Override

javaChannel	back to summary
protected SocketChannel javaChannel() Overrides io.netty.channel.nio.AbstractNioChannel.javaChannel. Annotations @Override

javaChannel

back to summary

protected SocketChannel javaChannel()

Overrides io.netty.channel.nio.AbstractNioChannel.javaChannel.

Annotations

@Override

localAddress back to summary

localAddress	back to summary
public InetSocketAddress localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.socket.SocketChannel.localAddress, io.netty.channel.Channel.localAddress. Doc from io.netty.channel.Channel.localAddress. Returns the local address where this channel is bound to. The returned `SocketAddress` is supposed to be down-cast into more concrete type such as `InetSocketAddress` to retrieve the detailed information. Returns:InetSocketAddress the local address of this channel. `null` if this channel is not bound. Annotations @Override

public InetSocketAddress localAddress()

Overrides io.netty.channel.AbstractChannel.localAddress.

Implements io.netty.channel.socket.SocketChannel.localAddress, io.netty.channel.Channel.localAddress.

Doc from io.netty.channel.Channel.localAddress.

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Returns:InetSocketAddress

the local address of this channel. null if this channel is not bound.

Annotations

@Override

localAddress0 back to summary

localAddress0	back to summary
protected SocketAddress localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Doc from io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally. Annotations @Override

protected SocketAddress localAddress0()

Implements abstract io.netty.channel.AbstractChannel.localAddress0.

Doc from io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Annotations

@Override

newChannel	back to summary
private static SocketChannel newChannel(SelectorProvider provider, InternetProtocolFamily family)

newUnsafe back to summary

newUnsafe	back to summary
protected AbstractNioChannel.AbstractNioUnsafe newUnsafe() Overrides io.netty.channel.nio.AbstractNioByteChannel.newUnsafe. Doc from io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel` Annotations @Override

protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()

Overrides io.netty.channel.nio.AbstractNioByteChannel.newUnsafe.

Doc from io.netty.channel.AbstractChannel.newUnsafe.

Create a new AbstractUnsafe instance which will be used for the life-time of the Channel

Annotations

@Override

parent back to summary

parent	back to summary
public ServerSocketChannel parent() Overrides io.netty.channel.AbstractChannel.parent. Implements io.netty.channel.socket.SocketChannel.parent, io.netty.channel.Channel.parent. Doc from io.netty.channel.Channel.parent. Returns the parent of this channel. Returns:ServerSocketChannel the parent channel. `null` if this channel does not have a parent channel. Annotations @Override

public ServerSocketChannel parent()

Overrides io.netty.channel.AbstractChannel.parent.

Implements io.netty.channel.socket.SocketChannel.parent, io.netty.channel.Channel.parent.

Doc from io.netty.channel.Channel.parent.

Returns the parent of this channel.

Returns:ServerSocketChannel

the parent channel. null if this channel does not have a parent channel.

Annotations

@Override

remoteAddress back to summary

remoteAddress	back to summary
public InetSocketAddress remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.socket.SocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress. Doc from io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to. The returned `SocketAddress` is supposed to be down-cast into more concrete type such as `InetSocketAddress` to retrieve the detailed information. Returns:InetSocketAddress the remote address of this channel. `null` if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. `DatagramChannel`, use `DatagramPacket#recipient()` to determine the origination of the received message as this method will return `null`. Annotations @Override

public InetSocketAddress remoteAddress()

Overrides io.netty.channel.AbstractChannel.remoteAddress.

Implements io.netty.channel.socket.SocketChannel.remoteAddress, io.netty.channel.Channel.remoteAddress.

Doc from io.netty.channel.Channel.remoteAddress.

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Returns:InetSocketAddress

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DatagramPacket#recipient() to determine the origination of the received message as this method will return null.

Annotations

@Override

remoteAddress0 back to summary

remoteAddress0	back to summary
protected SocketAddress remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Doc from io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to. Annotations @Override

protected SocketAddress remoteAddress0()

Implements abstract io.netty.channel.AbstractChannel.remoteAddress0.

Doc from io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Annotations

@Override

shutdown	back to summary
public ChannelFuture shutdown() Implements io.netty.channel.socket.DuplexChannel.shutdown. Doc from io.netty.channel.socket.DuplexChannel.shutdown. Will shutdown the input and output sides of this channel. Returns:ChannelFuture will be completed when both shutdown operations complete. Annotations @Override

shutdown

back to summary

public ChannelFuture shutdown()

Implements io.netty.channel.socket.DuplexChannel.shutdown.

Doc from io.netty.channel.socket.DuplexChannel.shutdown.

Will shutdown the input and output sides of this channel.

Returns:ChannelFuture

will be completed when both shutdown operations complete.

Annotations

@Override

shutdown	back to summary
public ChannelFuture shutdown(final ChannelPromise promise) Implements io.netty.channel.socket.DuplexChannel.shutdown. Doc from io.netty.channel.socket.DuplexChannel.shutdown. Will shutdown the input and output sides of this channel. Parameters promise:ChannelPromise will be completed when both shutdown operations complete. Returns:ChannelFuture will be completed when both shutdown operations complete. Annotations @Override

shutdown

back to summary

public ChannelFuture shutdown(final ChannelPromise promise)

Implements io.netty.channel.socket.DuplexChannel.shutdown.

Doc from io.netty.channel.socket.DuplexChannel.shutdown.

Will shutdown the input and output sides of this channel.

Parameters

promise:ChannelPromise: will be completed when both shutdown operations complete.

Returns:ChannelFuture

will be completed when both shutdown operations complete.

Annotations

@Override

shutdownDone	back to summary
private static void shutdownDone(ChannelFuture shutdownOutputFuture, ChannelFuture shutdownInputFuture, ChannelPromise promise)

shutdownInput	back to summary
public ChannelFuture shutdownInput() Implements abstract io.netty.channel.nio.AbstractNioByteChannel.shutdownInput. Implements io.netty.channel.socket.DuplexChannel.shutdownInput. Doc from io.netty.channel.nio.AbstractNioByteChannel.shutdownInput. Shutdown the input side of the channel. Annotations @Override

shutdownInput

back to summary

public ChannelFuture shutdownInput()

Implements abstract io.netty.channel.nio.AbstractNioByteChannel.shutdownInput.

Implements io.netty.channel.socket.DuplexChannel.shutdownInput.

Doc from io.netty.channel.nio.AbstractNioByteChannel.shutdownInput.

Shutdown the input side of the channel.

Annotations

@Override

shutdownInput back to summary

shutdownInput	back to summary
public ChannelFuture shutdownInput(final ChannelPromise promise) Implements io.netty.channel.socket.DuplexChannel.shutdownInput. Doc from io.netty.channel.socket.DuplexChannel.shutdownInput. Will shutdown the input and notify `ChannelPromise`. Annotations @Override

public ChannelFuture shutdownInput(final ChannelPromise promise)

Implements io.netty.channel.socket.DuplexChannel.shutdownInput.

Doc from io.netty.channel.socket.DuplexChannel.shutdownInput.

Will shutdown the input and notify ChannelPromise.

Annotations

@Override

shutdownInput0	back to summary
private void shutdownInput0(final ChannelPromise promise)

shutdownInput0	back to summary
private void shutdownInput0() throws Exception Annotations @SuppressJava6Requirement reason:Usage guarded by java version check

shutdownOutput	back to summary
public ChannelFuture shutdownOutput() Implements io.netty.channel.socket.DuplexChannel.shutdownOutput. Annotations @Override

shutdownOutput

back to summary

public ChannelFuture shutdownOutput()

Implements io.netty.channel.socket.DuplexChannel.shutdownOutput.

Annotations

@Override

shutdownOutput back to summary

shutdownOutput	back to summary
public ChannelFuture shutdownOutput(final ChannelPromise promise) Implements io.netty.channel.socket.DuplexChannel.shutdownOutput. Doc from io.netty.channel.socket.DuplexChannel.shutdownOutput. Will shutdown the output and notify `ChannelPromise`. Annotations @Override

public ChannelFuture shutdownOutput(final ChannelPromise promise)

Implements io.netty.channel.socket.DuplexChannel.shutdownOutput.

Doc from io.netty.channel.socket.DuplexChannel.shutdownOutput.

Will shutdown the output and notify ChannelPromise.

Annotations

@Override

shutdownOutputDone	back to summary
private void shutdownOutputDone(final ChannelFuture shutdownOutputFuture, final ChannelPromise promise)

io.netty.channel.socket.nio back to summary

private final Class NioSocketChannel.NioSocketChannelConfig

Class Inheritance

extends DefaultSocketChannelConfig

java.lang.Object
io.netty.channel.DefaultChannelConfig
io.netty.channel.socket.DefaultSocketChannelConfig
io.netty.channel.socket.nio.NioSocketChannel.NioSocketChannelConfig

Field Summary

Modifier and Type	Field and Description
private volatile int	maxBytesPerGatheringWrite

Inherited from io.netty.channel.socket.DefaultSocketChannelConfig:: javaSocket

Constructor Summary

Access	Constructor and Description
private	NioSocketChannelConfig(NioSocketChannel channel, Socket javaSocket)

Method Summary

Modifier and Type	Method and Description
protected void	autoReadCleared() Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared. Is called once `setAutoRead(boolean)` is called with `false` and `isAutoRead()` was `true` before.
private void	calculateMaxBytesPerGatheringWrite()
pack-priv int	getMaxBytesPerGatheringWrite()
public <T> T	getOption(ChannelOption<T> option) Overrides io.netty.channel.socket.DefaultSocketChannelConfig.getOption. Implements io.netty.channel.ChannelConfig.getOption. Return the value of the given `ChannelOption`
public Map<ChannelOption<?>, Object>	getOptions() Overrides io.netty.channel.socket.DefaultSocketChannelConfig.getOptions. Implements io.netty.channel.ChannelConfig.getOptions. Return all set `ChannelOption`'s.
private SocketChannel	jdkChannel()
pack-priv void	setMaxBytesPerGatheringWrite(int maxBytesPerGatheringWrite)
public <T> boolean	setOption(ChannelOption<T> option, T value) Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setOption. Implements io.netty.channel.ChannelConfig.setOption. Sets a configuration property with the specified name and value.
public NioSocketChannel.NioSocketChannelConfig	setSendBufferSize(int sendBufferSize) Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setSendBufferSize. Implements io.netty.channel.socket.SocketChannelConfig.setSendBufferSize. Sets the `StandardSocketOptions#SO_SNDBUF` option.

Field Detail

maxBytesPerGatheringWrite	back to summary
private volatile int maxBytesPerGatheringWrite

Constructor Detail

NioSocketChannelConfig	back to summary
private NioSocketChannelConfig(NioSocketChannel channel, Socket javaSocket)

Method Detail

autoReadCleared back to summary

protected void autoReadCleared()

Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared.

Doc from io.netty.channel.DefaultChannelConfig.autoReadCleared.

Is called once setAutoRead(boolean) is called with false and isAutoRead() was true before.

Annotations

@Override

calculateMaxBytesPerGatheringWrite	back to summary
private void calculateMaxBytesPerGatheringWrite()

getMaxBytesPerGatheringWrite	back to summary
pack-priv int getMaxBytesPerGatheringWrite()

getOption back to summary

public <T> T getOption(ChannelOption<T> option)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

Doc from io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption

Annotations

@Override

getOptions back to summary

public Map<ChannelOption<?>, Object> getOptions()

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

Doc from io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.

Annotations

@Override

jdkChannel	back to summary
private SocketChannel jdkChannel()

setMaxBytesPerGatheringWrite	back to summary
pack-priv void setMaxBytesPerGatheringWrite(int maxBytesPerGatheringWrite)

setOption back to summary

public <T> boolean setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Doc from io.netty.channel.ChannelConfig.setOption.

Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:

public boolean setOption(ChannelOption<T> option, T value) {
    if (super.setOption(option, value)) {
        return true;
    }

    if (option.equals(additionalOption)) {
        ....
        return true;
    }

    return false;
}

Returns:boolean

true if and only if the property has been set

Annotations

@Override

setSendBufferSize back to summary

public NioSocketChannel.NioSocketChannelConfig setSendBufferSize(int sendBufferSize)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setSendBufferSize.

Implements io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Sets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

io.netty.channel.socket.nio back to summary

private final Class NioSocketChannel.NioSocketChannelUnsafe

Class Inheritance

extends NioByteUnsafe

java.lang.Object
io.netty.channel.AbstractChannel.AbstractUnsafe
io.netty.channel.nio.AbstractNioChannel.AbstractNioUnsafe
io.netty.channel.nio.AbstractNioByteChannel.NioByteUnsafe
io.netty.channel.socket.nio.NioSocketChannel.NioSocketChannelUnsafe

Constructor Summary

Access	Constructor and Description
private	NioSocketChannelUnsafe()

Method Summary

Modifier and Type	Method and Description
protected Executor	prepareToClose() Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.prepareToClose. Prepares to close the `Channel`.

Inherited from io.netty.channel.nio.AbstractNioByteChannel.NioByteUnsafe:: read

Constructor Detail

NioSocketChannelUnsafe	back to summary
private NioSocketChannelUnsafe()

Method Detail

prepareToClose back to summary

protected Executor prepareToClose()

Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.prepareToClose.

Doc from io.netty.channel.AbstractChannel.AbstractUnsafe.prepareToClose.

Prepares to close the Channel. If this method returns an Executor, the caller must call the Executor#execute(Runnable) method with a task that calls doClose() on the returned Executor. If this method returns null, doClose() must be called from the caller thread. (i.e. EventLoop)

Annotations

@Override

public Class NioSocketChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class NioSocketChannel.NioSocketChannelConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class NioSocketChannel.NioSocketChannelUnsafe

Constructor Summary

Method Summary

Constructor Detail

Method Detail