Class LocalServerChannel

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 AbstractChannel
AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel
Channel.Unsafe
Constructor Summary

Constructors

Constructor

Description

LocalServerChannel()
Method Summary

Modifier and Type

Method

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 (ChannelPromise promise)

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.

protected AbstractChannel.AbstractUnsafe

newUnsafe()

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

LocalAddress

remoteAddress()

Returns the remote address where this channel is connected to.

Methods inherited from class AbstractServerChannel
doDisconnect, doWrite, filterOutboundMessage, metadata, remoteAddress0

Methods inherited from class AbstractChannel
closeFuture, compareTo, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, toString, unsafe, validateFileRegion, voidPromise

Methods inherited from class DefaultAttributeMap
attr, hasAttr

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeMap
attr, hasAttr

Methods inherited from interface Channel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable
compareTo

Constructor Details
- LocalServerChannel
  
  public LocalServerChannel()
Method Details
- 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(ChannelPromise promise)
  
  Description copied from class: AbstractChannel
  
  Is called after the Channel is registered with its EventLoop as part of the register process. Subclasses may override this method
  
  Overrides:
  
  doRegister in class AbstractChannel
  
  Parameters:
  
  promise - ChannelPromise that must be notified once done to continue the registration.
- 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.
- newUnsafe
  
  protected AbstractChannel.AbstractUnsafe newUnsafe()
  
  Description copied from class: AbstractChannel
  
  Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
  
  Overrides:
  
  newUnsafe in class AbstractServerChannel

Class LocalServerChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

Nested classes/interfaces inherited from interface Channel

Constructor Summary

Method Summary

Methods inherited from class AbstractServerChannel

Methods inherited from class AbstractChannel

Methods inherited from class DefaultAttributeMap

Methods inherited from class Object

Methods inherited from interface AttributeMap

Methods inherited from interface Channel

Methods inherited from interface Comparable

Constructor Details

LocalServerChannel

Method Details

config

localAddress

remoteAddress

isOpen

isActive

isCompatible

localAddress0

doRegister

doBind

doClose

doDeregister

doBeginRead

newLocalChannel

newUnsafe