Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	LocalChannel.ReaderStackDepth
private static enum	LocalChannel.State

Field Summary

Modifier and Type	Field and Description
private static final AtomicReferenceFieldUpdater<LocalChannel, Future<V>>	FINISH_READ_FUTURE_UPDATER
private volatile Future<?>	finishReadFuture
pack-priv final Queue<Object>	inboundBuffer
private volatile boolean	inputShutdown
private volatile LocalAddress	localAddress Hides io.netty5.channel.AbstractChannel.localAddress.
private static final InternalLogger	logger Hides io.netty5.channel.AbstractChannel.logger.
private static final int	MAX_READER_STACK_DEPTH
private volatile boolean	outputShutdown
private volatile LocalChannel	peer
private volatile boolean	readInProgress
private final Runnable	readNowTask
private volatile LocalAddress	remoteAddress Hides io.netty5.channel.AbstractChannel.remoteAddress.
private static final FastThreadLocal<LocalChannel.ReaderStackDepth>	STACK_DEPTH
private volatile LocalChannel.State	state
private volatile boolean	writeInProgress

Constructor Summary

Access	Constructor and Description
public	LocalChannel(EventLoop eventLoop)
protected	LocalChannel(LocalServerChannel parent, EventLoop eventLoop, LocalChannel peer)

Method Summary

Modifier and Type	Method and Description
public void	closeTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.closeTransportNow.
public void	deregisterTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.deregisterTransportNow.
protected void	doBind(SocketAddress the `SocketAddress` to bound to. localAddress) Implements abstract io.netty5.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress`
protected void	doClose() Implements abstract io.netty5.channel.AbstractChannel.doClose. Close the `Channel`
protected boolean	doConnect(SocketAddress the address of the remote peer. remoteAddress, SocketAddress the local address of this channel. localAddress, Buffer the initial data that is written during connect (if `ChannelOption#TCP_FASTOPEN_CONNECT` is supported and configured). If data is written care must be taken to update the `reader offset`. initialData) Implements abstract io.netty5.channel.AbstractChannel.doConnect. Connect to remote peer.
protected void	doDisconnect() Implements abstract io.netty5.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer
protected boolean	doFinishConnect(LocalAddress the remote address of the peer. requestedRemoteAddress) Implements abstract io.netty5.channel.AbstractChannel.doFinishConnect. Finish a connect request.
protected void	doRead(boolean `true` if a read was already pending when `read()` was called. wasReadPendingAlready) Implements abstract io.netty5.channel.AbstractChannel.doRead. Schedule a read operation.
protected boolean	doReadNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.ReadSink the `ReadSink` that should be called with messages that are read from the transport to propagate these. readSink) Implements abstract io.netty5.channel.AbstractChannel.doReadNow. Try to read a message from the transport and dispatch it via `ReadSink#processRead(int, int, Object)`.
protected void	doShutdown(ChannelShutdownDirection the direction to shut down. direction) Implements abstract io.netty5.channel.AbstractChannel.doShutdown. Shutdown one direction of the `Channel`.
protected void	doWriteNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.WriteSink the `WriteSink` that must be completed with the write progress. `WriteSink#complete(long, long, int, boolean)` or `WriteSink#complete(long, Throwable, boolean)` must be called exactly once before this method returns non-exceptional. writeSink) Implements abstract io.netty5.channel.AbstractChannel.doWriteNow. Called in a loop when writes should be performed until this method returns `false` or there are no more messages to write.
private void	finishConnectAsync()
private void	finishPeerRead(final LocalChannel peer)
private void	finishPeerRead0(LocalChannel peer)
public boolean	isActive() Implements io.netty5.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected.
public boolean	isOpen() Implements io.netty5.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later
public boolean	isShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.Channel.isShutdown. Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before.
protected LocalAddress	localAddress0() Implements abstract io.netty5.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally.
public void	registerTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.registerTransportNow.
private void	releaseInboundBuffers()
protected LocalAddress	remoteAddress0() Implements abstract io.netty5.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to.
private void	runFinishPeerReadTask(final LocalChannel peer)
private void	tryClose(boolean isActive)
private void	writeFlushedAsync()
protected void	writeLoopComplete(boolean `true` if all messages were written during the write loop, `false` otherwise. allWritten) Overrides io.netty5.channel.AbstractChannel.writeLoopComplete. Called once the write loop completed.

Field Detail

FINISH_READ_FUTURE_UPDATER	back to summary
private static final AtomicReferenceFieldUpdater<LocalChannel, Future<V>> FINISH_READ_FUTURE_UPDATER Annotations @SuppressWarnings:rawtypes

finishReadFuture	back to summary
private volatile Future<?> finishReadFuture

inboundBuffer	back to summary
pack-priv final Queue<Object> inboundBuffer

inputShutdown	back to summary
private volatile boolean inputShutdown

localAddress	back to summary
private volatile LocalAddress localAddress Hides io.netty5.channel.AbstractChannel.localAddress.

logger	back to summary
private static final InternalLogger logger Hides io.netty5.channel.AbstractChannel.logger.

MAX_READER_STACK_DEPTH	back to summary
private static final int MAX_READER_STACK_DEPTH

outputShutdown	back to summary
private volatile boolean outputShutdown

peer	back to summary
private volatile LocalChannel peer

readInProgress	back to summary
private volatile boolean readInProgress

readNowTask	back to summary
private final Runnable readNowTask

remoteAddress	back to summary
private volatile LocalAddress remoteAddress Hides io.netty5.channel.AbstractChannel.remoteAddress.

STACK_DEPTH	back to summary
private static final FastThreadLocal<LocalChannel.ReaderStackDepth> STACK_DEPTH

state	back to summary
private volatile LocalChannel.State state

writeInProgress	back to summary
private volatile boolean writeInProgress

Constructor Detail

LocalChannel	back to summary
public LocalChannel(EventLoop eventLoop)

LocalChannel	back to summary
protected LocalChannel(LocalServerChannel parent, EventLoop eventLoop, LocalChannel peer)

Method Detail

closeTransportNow	back to summary
public void closeTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.closeTransportNow. Annotations @Override

closeTransportNow

back to summary

public void closeTransportNow()

Implements io.netty5.channel.local.LocalChannelUnsafe.closeTransportNow.

Annotations

@Override

deregisterTransportNow	back to summary
public void deregisterTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.deregisterTransportNow. Annotations @Override

deregisterTransportNow

back to summary

public void deregisterTransportNow()

Implements io.netty5.channel.local.LocalChannelUnsafe.deregisterTransportNow.

Annotations

@Override

doBind back to summary

doBind	back to summary
protected void doBind(SocketAddress localAddress) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doBind. Doc from io.netty5.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress` Parameters localAddress:SocketAddress the `SocketAddress` to bound to. Annotations @Override Exceptions Exception: when an error happens.

protected void doBind(SocketAddress localAddress) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doBind.

Doc from io.netty5.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Parameters

localAddress:SocketAddress: the SocketAddress to bound to.

Annotations

@Override

Exceptions

Exception:: when an error happens.

doClose back to summary

doClose	back to summary
protected void doClose() throws Exception Implements abstract io.netty5.channel.AbstractChannel.doClose. Doc from io.netty5.channel.AbstractChannel.doClose. Close the `Channel` Annotations @Override Exceptions Exception: thrown on error.

protected void doClose() throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doClose.

Doc from io.netty5.channel.AbstractChannel.doClose.

Close the Channel

Annotations

@Override

Exceptions

Exception:: thrown on error.

doConnect back to summary

doConnect	back to summary
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress, Buffer initialData) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doConnect. Doc from io.netty5.channel.AbstractChannel.doConnect. Connect to remote peer. This method should never be directly called. Parameters remoteAddress:SocketAddress the address of the remote peer. localAddress:SocketAddress the local address of this channel. initialData:Buffer the initial data that is written during connect (if `ChannelOption#TCP_FASTOPEN_CONNECT` is supported and configured). If data is written care must be taken to update the `reader offset`. Returns:boolean `true` if the connect operation was completed, `false` if `finishConnect()` will be called later again to try finish connecting. Annotations @Override Exceptions Exception: thrown on error.

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

Implements abstract io.netty5.channel.AbstractChannel.doConnect.

Doc from io.netty5.channel.AbstractChannel.doConnect.

Connect to remote peer. This method should never be directly called.

Parameters

remoteAddress:SocketAddress: the address of the remote peer.
localAddress:SocketAddress: the local address of this channel.
initialData:Buffer: the initial data that is written during connect (if ChannelOption#TCP_FASTOPEN_CONNECT is supported and configured). If data is written care must be taken to update the reader offset.

Returns:boolean

true if the connect operation was completed, false if finishConnect() will be called later again to try finish connecting.

Annotations

@Override

Exceptions

Exception:: thrown on error.

doDisconnect back to summary

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

protected void doDisconnect() throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doDisconnect.

Doc from io.netty5.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer

Annotations

@Override

Exceptions

Exception:: thrown on error.

doFinishConnect back to summary

doFinishConnect	back to summary
protected boolean doFinishConnect(LocalAddress requestedRemoteAddress) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doFinishConnect. Doc from io.netty5.channel.AbstractChannel.doFinishConnect. Finish a connect request. This method should never be directly called, use `finishConnect()` instead. Parameters requestedRemoteAddress:LocalAddress the remote address of the peer. Returns:boolean `true` if the connect operations was completed, `false` if `finishConnect()` will be called later again to try finishing the connect operation. Annotations @Override Exceptions Exception: thrown on error.

protected boolean doFinishConnect(LocalAddress requestedRemoteAddress) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doFinishConnect.

Doc from io.netty5.channel.AbstractChannel.doFinishConnect.

Finish a connect request. This method should never be directly called, use finishConnect() instead.

Parameters

requestedRemoteAddress:LocalAddress: the remote address of the peer.

Returns:boolean

true if the connect operations was completed, false if finishConnect() will be called later again to try finishing the connect operation.

Annotations

@Override

Exceptions

Exception:: thrown on error.

doRead back to summary

doRead	back to summary
protected void doRead(boolean wasReadPendingAlready) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doRead. Doc from io.netty5.channel.AbstractChannel.doRead. Schedule a read operation. Parameters wasReadPendingAlready:boolean `true` if a read was already pending when `read()` was called. Annotations @Override Exceptions Exception: thrown on error.

protected void doRead(boolean wasReadPendingAlready) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doRead.

Doc from io.netty5.channel.AbstractChannel.doRead.

Schedule a read operation.

Parameters

wasReadPendingAlready:boolean: true if a read was already pending when read() was called.

Annotations

@Override

Exceptions

Exception:: thrown on error.

doReadNow back to summary

doReadNow	back to summary
protected boolean doReadNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.ReadSink readSink) Implements abstract io.netty5.channel.AbstractChannel.doReadNow. Doc from io.netty5.channel.AbstractChannel.doReadNow. Try to read a message from the transport and dispatch it via `ReadSink#processRead(int, int, Object)`. This method is called in a loop until there is nothing more messages to read or the channel was shutdown / closed. This method should never be called directly by sub-classes, use `readNow()` instead. Parameters readSink:AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.ReadSink the `ReadSink` that should be called with messages that are read from the transport to propagate these. Returns:boolean `true` if the channel should be shutdown / closed. Annotations @Override

protected boolean doReadNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.ReadSink readSink)

Implements abstract io.netty5.channel.AbstractChannel.doReadNow.

Doc from io.netty5.channel.AbstractChannel.doReadNow.

Try to read a message from the transport and dispatch it via ReadSink#processRead(int, int, Object). This method is called in a loop until there is nothing more messages to read or the channel was shutdown / closed. This method should never be called directly by sub-classes, use readNow() instead.

Parameters

readSink:AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.ReadSink: the ReadSink that should be called with messages that are read from the transport to propagate these.

Returns:boolean

true if the channel should be shutdown / closed.

Annotations

@Override

doShutdown back to summary

doShutdown	back to summary
protected void doShutdown(ChannelShutdownDirection direction) Implements abstract io.netty5.channel.AbstractChannel.doShutdown. Doc from io.netty5.channel.AbstractChannel.doShutdown. Shutdown one direction of the `Channel`. Parameters direction:ChannelShutdownDirection the direction to shut down. Annotations @Override

protected void doShutdown(ChannelShutdownDirection direction)

Implements abstract io.netty5.channel.AbstractChannel.doShutdown.

Doc from io.netty5.channel.AbstractChannel.doShutdown.

Shutdown one direction of the Channel.

Parameters

direction:ChannelShutdownDirection: the direction to shut down.

Annotations

@Override

doWriteNow back to summary

doWriteNow	back to summary
protected void doWriteNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.WriteSink writeSink) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doWriteNow. Doc from io.netty5.channel.AbstractChannel.doWriteNow. Called in a loop when writes should be performed until this method returns `false` or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if `Buffer`s are written partial implementations need to ensure the `readerOffset` is updated accordingly. Parameters writeSink:AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.WriteSink the `WriteSink` that must be completed with the write progress. `WriteSink#complete(long, long, int, boolean)` or `WriteSink#complete(long, Throwable, boolean)` must be called exactly once before this method returns non-exceptional. Annotations @Override Exceptions Exception: if an error happened during writing. This will also terminate the write loop.

protected void doWriteNow(AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.WriteSink writeSink) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doWriteNow.

Doc from io.netty5.channel.AbstractChannel.doWriteNow.

Called in a loop when writes should be performed until this method returns false or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if Buffers are written partial implementations need to ensure the readerOffset is updated accordingly.

Parameters

writeSink:AbstractChannel<LocalServerChannel, LocalAddress, LocalAddress>.WriteSink: the WriteSink that must be completed with the write progress. WriteSink#complete(long, long, int, boolean) or WriteSink#complete(long, Throwable, boolean) must be called exactly once before this method returns non-exceptional.

Annotations

@Override

Exceptions

Exception:: if an error happened during writing. This will also terminate the write loop.

finishConnectAsync	back to summary
private void finishConnectAsync()

finishPeerRead	back to summary
private void finishPeerRead(final LocalChannel peer)

finishPeerRead0	back to summary
private void finishPeerRead0(LocalChannel peer)

isActive back to summary

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

public boolean isActive()

Implements io.netty5.channel.Channel.isActive.

Doc from io.netty5.channel.Channel.isActive.

Return true if the Channel is active and so connected.

Annotations

@Override

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements io.netty5.channel.Channel.isOpen. Doc from io.netty5.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later Annotations @Override

public boolean isOpen()

Implements io.netty5.channel.Channel.isOpen.

Doc from io.netty5.channel.Channel.isOpen.

Returns true if the Channel is open and may get active later

Annotations

@Override

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.Channel.isShutdown. Doc from io.netty5.channel.Channel.isShutdown. Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before. Annotations @Override

public boolean isShutdown(ChannelShutdownDirection direction)

Implements io.netty5.channel.Channel.isShutdown.

Doc from io.netty5.channel.Channel.isShutdown.

Returns true if the ChannelShutdownDirection of the Channel was shutdown before.

Annotations

@Override

localAddress0 back to summary

localAddress0	back to summary
protected LocalAddress localAddress0() Implements abstract io.netty5.channel.AbstractChannel.localAddress0. Doc from io.netty5.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally. Returns:LocalAddress the local address if any, `null` otherwise. Annotations @Override

protected LocalAddress localAddress0()

Implements abstract io.netty5.channel.AbstractChannel.localAddress0.

Doc from io.netty5.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Returns:LocalAddress

the local address if any, null otherwise.

Annotations

@Override

registerTransportNow	back to summary
public void registerTransportNow() Implements io.netty5.channel.local.LocalChannelUnsafe.registerTransportNow. Annotations @Override

registerTransportNow

back to summary

public void registerTransportNow()

Implements io.netty5.channel.local.LocalChannelUnsafe.registerTransportNow.

Annotations

@Override

releaseInboundBuffers	back to summary
private void releaseInboundBuffers()

remoteAddress0 back to summary

remoteAddress0	back to summary
protected LocalAddress remoteAddress0() Implements abstract io.netty5.channel.AbstractChannel.remoteAddress0. Doc from io.netty5.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to. Returns:LocalAddress the remote address if any, `null` otherwise. Annotations @Override

protected LocalAddress remoteAddress0()

Implements abstract io.netty5.channel.AbstractChannel.remoteAddress0.

Doc from io.netty5.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Returns:LocalAddress

the remote address if any, null otherwise.

Annotations

@Override

runFinishPeerReadTask	back to summary
private void runFinishPeerReadTask(final LocalChannel peer)

tryClose	back to summary
private void tryClose(boolean isActive)

writeFlushedAsync	back to summary
private void writeFlushedAsync()

writeLoopComplete back to summary

writeLoopComplete	back to summary
protected void writeLoopComplete(boolean allWritten) Overrides io.netty5.channel.AbstractChannel.writeLoopComplete. Doc from io.netty5.channel.AbstractChannel.writeLoopComplete. Called once the write loop completed. Subclasses might override this method for custom logic but should also call super. Parameters allWritten:boolean `true` if all messages were written during the write loop, `false` otherwise. Annotations @Override

protected void writeLoopComplete(boolean allWritten)

Overrides io.netty5.channel.AbstractChannel.writeLoopComplete.

Doc from io.netty5.channel.AbstractChannel.writeLoopComplete.

Called once the write loop completed. Subclasses might override this method for custom logic but should also call super.

Parameters

allWritten:boolean: true if all messages were written during the write loop, false otherwise.

Annotations

@Override

io.netty5.channel.local back to summary

private final Class LocalChannel.ReaderStackDepth

Class Inheritance

extends Object

java.lang.Object
io.netty5.channel.local.LocalChannel.ReaderStackDepth

Field Summary

Modifier and Type	Field and Description
private int	stackDepth

Constructor Summary

Access	Constructor and Description
private	ReaderStackDepth()

Method Summary

Modifier and Type	Method and Description
pack-priv void	decrement()
pack-priv boolean	incrementIfPossible()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

stackDepth	back to summary
private int stackDepth

Constructor Detail

ReaderStackDepth	back to summary
private ReaderStackDepth()

Method Detail

decrement	back to summary
pack-priv void decrement()

incrementIfPossible	back to summary
pack-priv boolean incrementIfPossible()

io.netty5.channel.local back to summary

private final Enum LocalChannel.State

Class Inheritance

extends Enum<LocalChannel.State>

java.lang.Object
java.lang.Enum
io.netty5.channel.local.LocalChannel.State

Field Summary

Modifier and Type	Field and Description
public static final LocalChannel.State	BOUND
public static final LocalChannel.State	CLOSED
public static final LocalChannel.State	CONNECTED
public static final LocalChannel.State	OPEN

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static LocalChannel.State	valueOf(String name)
public static LocalChannel.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOUND	back to summary
public static final LocalChannel.State BOUND

CLOSED	back to summary
public static final LocalChannel.State CLOSED

CONNECTED	back to summary
public static final LocalChannel.State CONNECTED

OPEN	back to summary
public static final LocalChannel.State OPEN

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static LocalChannel.State valueOf(String name)

values	back to summary
public static LocalChannel.State[] values()

public Class LocalChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LocalChannel.ReaderStackDepth

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum LocalChannel.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail