public class LocalChannel extends AbstractChannel
Channel
for the local transport.Modifier and Type | Class and Description |
---|---|
private class |
LocalChannel.LocalUnsafe |
AbstractChannel.AbstractUnsafe
Channel.Unsafe
Modifier and Type | Field and Description |
---|---|
private ChannelConfig |
config |
private ChannelPromise |
connectPromise |
private static java.nio.channels.ClosedChannelException |
DO_CLOSE_CLOSED_CHANNEL_EXCEPTION |
private static java.nio.channels.ClosedChannelException |
DO_WRITE_CLOSED_CHANNEL_EXCEPTION |
private static java.util.concurrent.atomic.AtomicReferenceFieldUpdater<LocalChannel,Future> |
FINISH_READ_FUTURE_UPDATER |
private Future<?> |
finishReadFuture |
private java.util.Queue<java.lang.Object> |
inboundBuffer |
private LocalAddress |
localAddress |
private static int |
MAX_READER_STACK_DEPTH |
private static ChannelMetadata |
METADATA |
private LocalChannel |
peer |
private boolean |
readInProgress |
private java.lang.Runnable |
readTask |
private boolean |
registerInProgress |
private LocalAddress |
remoteAddress |
private java.lang.Runnable |
shutdownHook |
private int |
state |
private boolean |
writeInProgress |
Constructor and Description |
---|
LocalChannel() |
LocalChannel(LocalServerChannel parent,
LocalChannel peer) |
Modifier and Type | Method and 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()
|
protected void |
doDisconnect()
Disconnect this
Channel from its remote peer |
private void |
doPeerClose(LocalChannel peer,
boolean peerWriteInProgress) |
protected void |
doRegister()
|
protected void |
doWrite(ChannelOutboundBuffer in)
Flush the content of the given buffer to the remote peer.
|
private void |
finishPeerRead(LocalChannel peer) |
private void |
finishPeerRead0(LocalChannel 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()
|
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.
|
private void |
releaseInboundBuffers() |
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. |
private void |
runFinishPeerReadTask(LocalChannel peer) |
alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, eventLoop, filterOutboundMessage, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush
attr
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
attr
private static final java.util.concurrent.atomic.AtomicReferenceFieldUpdater<LocalChannel,Future> FINISH_READ_FUTURE_UPDATER
private static final ChannelMetadata METADATA
private static final int MAX_READER_STACK_DEPTH
private static final java.nio.channels.ClosedChannelException DO_WRITE_CLOSED_CHANNEL_EXCEPTION
private static final java.nio.channels.ClosedChannelException DO_CLOSE_CLOSED_CHANNEL_EXCEPTION
private final ChannelConfig config
private final java.util.Queue<java.lang.Object> inboundBuffer
private final java.lang.Runnable readTask
private final java.lang.Runnable shutdownHook
private volatile int state
private volatile LocalChannel peer
private volatile LocalAddress localAddress
private volatile LocalAddress remoteAddress
private volatile ChannelPromise connectPromise
private volatile boolean readInProgress
private volatile boolean registerInProgress
private volatile boolean writeInProgress
private volatile Future<?> finishReadFuture
public LocalChannel()
LocalChannel(LocalServerChannel parent, LocalChannel peer)
public ChannelMetadata metadata()
Channel
public ChannelConfig config()
Channel
public LocalServerChannel parent()
Channel
parent
in interface Channel
parent
in class AbstractChannel
null
if this channel does not have a parent channel.public LocalAddress localAddress()
Channel
SocketAddress
is supposed to be down-cast into more concrete
type such as InetSocketAddress
to retrieve the detailed
information.localAddress
in interface Channel
localAddress
in class AbstractChannel
null
if this channel is not bound.public LocalAddress remoteAddress()
Channel
SocketAddress
is supposed to be down-cast into more
concrete type such as InetSocketAddress
to retrieve the detailed
information.remoteAddress
in interface Channel
remoteAddress
in class AbstractChannel
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
.public boolean isOpen()
Channel
true
if the Channel
is open and may get active laterpublic boolean isActive()
Channel
true
if the Channel
is active and so connected.protected AbstractChannel.AbstractUnsafe newUnsafe()
AbstractChannel
AbstractChannel.AbstractUnsafe
instance which will be used for the life-time of the Channel
newUnsafe
in class AbstractChannel
protected boolean isCompatible(EventLoop loop)
AbstractChannel
true
if the given EventLoop
is compatible with this instance.isCompatible
in class AbstractChannel
protected java.net.SocketAddress localAddress0()
AbstractChannel
SocketAddress
which is bound locally.localAddress0
in class AbstractChannel
protected java.net.SocketAddress remoteAddress0()
AbstractChannel
SocketAddress
which the Channel
is connected to.remoteAddress0
in class AbstractChannel
protected void doRegister() throws java.lang.Exception
AbstractChannel
Channel
is registered with its EventLoop
as part of the register process.
Sub-classes may override this methoddoRegister
in class AbstractChannel
java.lang.Exception
protected void doBind(java.net.SocketAddress localAddress) throws java.lang.Exception
AbstractChannel
Channel
to the SocketAddress
doBind
in class AbstractChannel
java.lang.Exception
protected void doDisconnect() throws java.lang.Exception
AbstractChannel
Channel
from its remote peerdoDisconnect
in class AbstractChannel
java.lang.Exception
protected void doClose() throws java.lang.Exception
AbstractChannel
Channel
doClose
in class AbstractChannel
java.lang.Exception
private void doPeerClose(LocalChannel peer, boolean peerWriteInProgress)
protected void doDeregister() throws java.lang.Exception
AbstractChannel
doDeregister
in class AbstractChannel
java.lang.Exception
protected void doBeginRead() throws java.lang.Exception
AbstractChannel
doBeginRead
in class AbstractChannel
java.lang.Exception
protected void doWrite(ChannelOutboundBuffer in) throws java.lang.Exception
AbstractChannel
doWrite
in class AbstractChannel
java.lang.Exception
private void finishPeerRead(LocalChannel peer)
private void runFinishPeerReadTask(LocalChannel peer)
private void releaseInboundBuffers()
private void finishPeerRead0(LocalChannel peer)