io.netty.channel.local

Class LocalServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.AbstractServerChannel

io.netty.channel.local.LocalServerChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, AttributeMap, Comparable<Channel>

public class LocalServerChannel
extends AbstractServerChannel

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

Nested Class Summary

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

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Constructor Summary

Constructors

Constructor and Description
LocalServerChannel()

Method Summary

Modifier and Type	Method and Description
ChannelConfig	config() Returns the configuration of this channel.
protected void	doBeginRead() Schedule a read operation.
protected void	doBind(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected void	doDeregister() Deregister the Channel from its EventLoop.
protected void	doRegister() Is called after the Channel is registered with its EventLoop as part of the register process.
boolean	isActive() Return true if the Channel is active and so connected.
protected boolean	isCompatible(EventLoop loop) Return true if the given EventLoop is compatible with this instance.
boolean	isOpen() Returns true if the Channel is open and may get active later
LocalAddress	localAddress() Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
protected LocalChannel	newLocalChannel(LocalChannel peer) A factory method for LocalChannels.
LocalAddress	remoteAddress() Returns the remote address where this channel is connected to.

Methods inherited from class io.netty.channel.AbstractServerChannel

doDisconnect, doWrite, filterOutboundMessage, metadata, newUnsafe, remoteAddress0

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isRegistered, isWritable, parent, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

LocalServerChannel

public LocalServerChannel()

Method Detail

config

public ChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

localAddress

public LocalAddress localAddress()

Description copied from interface: Channel

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.

Specified by:

localAddress in interface Channel

Overrides:

localAddress in class AbstractChannel

Returns:

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

remoteAddress

public LocalAddress remoteAddress()

Description copied from interface: Channel

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.

Specified by:

remoteAddress in interface Channel

Overrides:

remoteAddress in class AbstractServerChannel

Returns:

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 DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

isOpen

public boolean isOpen()

Description copied from interface: Channel

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

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

isCompatible

protected boolean isCompatible(EventLoop loop)

Description copied from class: AbstractChannel

Return true if the given EventLoop is compatible with this instance.

Specified by:

isCompatible in class AbstractChannel

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

doRegister

protected void doRegister()
                   throws Exception

Description copied from class: AbstractChannel

Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method

Overrides:

doRegister in class AbstractChannel

Throws:

Exception

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

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doDeregister

protected void doDeregister()
                     throws Exception

Description copied from class: AbstractChannel

Deregister the Channel from its EventLoop. Sub-classes may override this method

Overrides:

doDeregister in class AbstractChannel

Throws:

Exception

doBeginRead

protected void doBeginRead()
                    throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

Exception

newLocalChannel

protected LocalChannel newLocalChannel(LocalChannel peer)

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