Module io.netty5.transport

Package io.netty5.channel.local

Class LocalServerChannel

java.lang.Object

io.netty5.util.DefaultAttributeMap

io.netty5.channel.AbstractChannel<P,L,R>

io.netty5.channel.AbstractServerChannel<LocalChannel,LocalAddress,LocalAddress>

io.netty5.channel.local.LocalServerChannel

All Implemented Interfaces:

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

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

A ServerChannel for the local transport which allows in VM communication.

Nested Class Summary

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

AbstractChannel.DefaultAbstractChannelPipeline, AbstractChannel.ReadSink, AbstractChannel.WriteSink

Constructor Summary

Constructors

Constructor	Description
LocalServerChannel(EventLoop eventLoop, EventLoopGroup childEventLoopGroup)

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 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).
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
protected LocalAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected LocalChannel	newLocalChannel(LocalChannel peer)	A factory method for LocalChannels.
void	registerTransportNow()

Methods inherited from class io.netty5.channel.AbstractServerChannel

childEventLoopGroup, doConnect, doDisconnect, doFinishConnect, doShutdown, doWriteNow, filterOutboundMessage, isShutdown, remoteAddress0

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, doClearScheduledRead, equals, executor, 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, writeLoopComplete

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, bufferAllocator, close, closeFuture, connect, connect, deregister, disconnect, executor, flush, getOption, id, isOptionSupported, isWritable, localAddress, parent, pipeline, read, read, register, remoteAddress, sendOutboundEvent, setOption, shutdown, writableBytes, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty5.channel.IoHandle

isRegistered

Constructor Detail

LocalServerChannel

public LocalServerChannel(EventLoop eventLoop,
                          EventLoopGroup childEventLoopGroup)

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<LocalChannel,LocalAddress,LocalAddress>

Returns:

the local 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<LocalChannel,LocalAddress,LocalAddress>

Parameters:

localAddress - the SocketAddress to bound to.

Throws:

Exception - when an error happens.

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel<LocalChannel,LocalAddress,LocalAddress>

Throws:

Exception - thrown on error.

doRead

protected void doRead(boolean wasReadPendingAlready)
               throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doRead in class AbstractChannel<LocalChannel,LocalAddress,LocalAddress>

Parameters:

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

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<LocalChannel,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.

newLocalChannel

protected LocalChannel newLocalChannel(LocalChannel peer)

A factory method for LocalChannels. Users may override it to create custom instances of LocalChannels.

registerTransportNow

public void registerTransportNow()

deregisterTransportNow

public void deregisterTransportNow()

closeTransportNow

public void closeTransportNow()