Module io.netty5.transport

Package io.netty5.channel.local

Class LocalChannel

java.lang.Object

io.netty5.util.DefaultAttributeMap

io.netty5.channel.AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

io.netty5.channel.local.LocalChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, IoHandle, io.netty5.util.AttributeMap, io.netty5.util.concurrent.FuturePromiseFactory, Comparable<Channel>

public class LocalChannel
extends AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

A Channel for the local transport.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty5.channel.AbstractChannel

AbstractChannel.DefaultAbstractChannelPipeline, AbstractChannel.ReadSink, AbstractChannel.WriteSink

Constructor Summary

Constructors

Modifier	Constructor	Description
	LocalChannel(EventLoop eventLoop)
protected	LocalChannel(LocalServerChannel parent, EventLoop eventLoop, LocalChannel peer)

Method Summary

Modifier and Type	Method	Description
void	closeTransportNow()
void	deregisterTransportNow()
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty5.buffer.Buffer initialData)	Connect to remote peer.
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected boolean	doFinishConnect(LocalAddress requestedRemoteAddress)	Finish a connect request.
protected void	doRead(boolean wasReadPendingAlready)	Schedule a read operation.
protected boolean	doReadNow(AbstractChannel.ReadSink readSink)	Try to read a message from the transport and dispatch it via AbstractChannel.ReadSink.processRead(int, int, Object).
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected void	doWriteNow(AbstractChannel.WriteSink writeSink)	Called in a loop when writes should be performed until this method returns false or there are no more messages to write.
boolean	isActive()	Return true if the Channel is active and so connected.
boolean	isOpen()	Returns true if the Channel is open and may get active later
boolean	isShutdown(ChannelShutdownDirection direction)	Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
protected LocalAddress	localAddress0()	Returns the SocketAddress which is bound locally.
void	registerTransportNow()
protected LocalAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected void	writeLoopComplete(boolean allWritten)	Called once the write loop completed.

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, doClearScheduledRead, equals, executor, filterOutboundMessage, finishConnect, getExtendedOption, getOption, hashCode, id, isConnectPending, isExtendedOptionSupported, isOptionSupported, isReadPending, isRegistered, isSupportingDisconnect, isWriteFlushedScheduled, localAddress, newChannelPipeline, newSupportedIdentityOptionsSet, parent, pipeline, prepareToClose, readBufferAllocator, readHandle, readIfIsAutoRead, readLoopComplete, readNow, remoteAddress, setExtendedOption, setOption, shutdownReadSide, toString, validateEventLoopGroup, validateFileRegion, writableBytes, writeFlushed, writeFlushedNow, writeHandle

Methods inherited from class io.netty5.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty5.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty5.channel.Channel

bind, close, connect, connect, deregister, disconnect, flush, isWritable, read, read, register, sendOutboundEvent, shutdown, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Constructor Detail

LocalChannel

public LocalChannel(EventLoop eventLoop)

LocalChannel

protected LocalChannel(LocalServerChannel parent,
                       EventLoop eventLoop,
                       LocalChannel peer)

Method Detail

isOpen

public boolean isOpen()

Description copied from interface: Channel

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

Specified by:

isOpen in interface Channel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

localAddress0

protected LocalAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Returns:

the local address if any, null otherwise.

remoteAddress0

protected LocalAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Returns:

the remote address if any, null otherwise.

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

localAddress - the SocketAddress to bound to.

Throws:

Exception - when an error happens.

doShutdown

protected void doShutdown(ChannelShutdownDirection direction)

Description copied from class: AbstractChannel

Shutdown one direction of the Channel.

Specified by:

doShutdown in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

direction - the direction to shut down.

isShutdown

public boolean isShutdown(ChannelShutdownDirection direction)

Description copied from interface: Channel

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

Specified by:

isShutdown in interface Channel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Throws:

Exception - thrown on error.

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Throws:

Exception - thrown on error.

doReadNow

protected boolean doReadNow(AbstractChannel.ReadSink readSink)

Description copied from class: AbstractChannel

Try to read a message from the transport and dispatch it via AbstractChannel.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 AbstractChannel.readNow() instead.

Specified by:

doReadNow in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

readSink - the AbstractChannel.ReadSink that should be called with messages that are read from the transport to propagate these.

Returns:

true if the channel should be shutdown / closed.

doRead

protected void doRead(boolean wasReadPendingAlready)
               throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doRead in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

wasReadPendingAlready - true if a read was already pending when Channel.read() was called.

Throws:

Exception - thrown on error.

doWriteNow

protected void doWriteNow(AbstractChannel.WriteSink writeSink)
                   throws Exception

Description copied from class: AbstractChannel

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.

Specified by:

doWriteNow in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

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

Throws:

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

writeLoopComplete

protected void writeLoopComplete(boolean allWritten)

Description copied from class: AbstractChannel

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

Overrides:

writeLoopComplete in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

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

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress,
                            io.netty5.buffer.Buffer initialData)
                     throws Exception

Description copied from class: AbstractChannel

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

Specified by:

doConnect in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

remoteAddress - the address of the remote peer.

localAddress - the local address of this channel.

initialData - 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:

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

Throws:

Exception - thrown on error.

doFinishConnect

protected boolean doFinishConnect(LocalAddress requestedRemoteAddress)
                           throws Exception

Description copied from class: AbstractChannel

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

Specified by:

doFinishConnect in class AbstractChannel<LocalServerChannel,LocalAddress,LocalAddress>

Parameters:

requestedRemoteAddress - the remote address of the peer.

Returns:

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

Throws:

Exception - thrown on error.

registerTransportNow

public void registerTransportNow()

deregisterTransportNow

public void deregisterTransportNow()

closeTransportNow

public void closeTransportNow()