java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.local.LocalChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, AttributeMap, java.lang.Comparable<Channel>
```
public class LocalChannel
extends AbstractChannel
```
A Channel for the local transport.

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
Modifier Constructor Description

LocalChannel()

protected LocalChannel(LocalServerChannel parent, LocalChannel peer)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ChannelConfig`	`config()`	Returns the configuration of this channel.
`protected void`	`doBeginRead()`	Schedule a read operation.
`protected void`	`doBind(java.net.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`	`doDisconnect()`	Disconnect this `Channel` from its remote peer
`protected void`	`doRegister(ChannelPromise promise)`	Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected void`	`doWrite(ChannelOutboundBuffer in)`	Flush the content of the given buffer to the remote peer.
`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 java.net.SocketAddress`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()`	Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected AbstractChannel.AbstractUnsafe`	`newUnsafe()`	Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`LocalServerChannel`	`parent()`	Returns the parent of this channel.
`LocalAddress`	`remoteAddress()`	Returns the remote address where this channel is connected to.
`protected java.net.SocketAddress`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.

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

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.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty.channel.Channel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

- Constructor Detail
  - LocalChannel
```
public LocalChannel()
```
  - LocalChannel
```
protected LocalChannel(LocalServerChannel parent,
                       LocalChannel peer)
```
- Method Detail
  - metadata
```
public ChannelMetadata metadata()
```
    Description copied from interface: Channel
    
    Return the ChannelMetadata of the Channel which describe the nature of the Channel.
  - config
```
public ChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
  - parent
```
public LocalServerChannel parent()
```
    Description copied from interface: Channel
    
    Returns the parent of this channel.
    
    Specified by:
    
    parent in interface Channel
    
    Overrides:
    
    parent in class AbstractChannel
    
    Returns:
    
    the parent channel. null if this channel does not have a parent 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 AbstractChannel
    
    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.
  - 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
    
    Specified by:
    
    newUnsafe in class AbstractChannel
  - 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 java.net.SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    Specified by:
    
    remoteAddress0 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.
  - doDeregister
```
protected void doDeregister()
                     throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Deregister the Channel from its EventLoop. Sub-classes may override this method
    
    Overrides:
    
    doDeregister in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Specified by:
    
    doBind in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Disconnect this Channel from its remote peer
    
    Specified by:
    
    doDisconnect in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Specified by:
    
    doClose in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doBeginRead
```
protected void doBeginRead()
                    throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    Specified by:
    
    doWrite in class AbstractChannel
    
    Throws:
    
    java.lang.Exception

Modifier	Constructor	Description
	`LocalChannel()`
`protected`	`LocalChannel(LocalServerChannel parent, LocalChannel peer)`

Class LocalChannel

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.Channel

Constructor Detail

LocalChannel

LocalChannel

Method Detail

metadata

config

parent

localAddress

remoteAddress

isOpen

isActive

newUnsafe

isCompatible

localAddress0

remoteAddress0

doRegister

doDeregister

doBind

doDisconnect

doClose

doBeginRead

doWrite