Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	LocalChannel.LocalUnsafe
private static enum	LocalChannel.State

Field Summary

Modifier and Type	Field and Description
private final ChannelConfig	config
private volatile ChannelPromise	connectPromise
private static final AtomicReferenceFieldUpdater<LocalChannel, Future<V>>	FINISH_READ_FUTURE_UPDATER
private volatile Future<?>	finishReadFuture
pack-priv final Queue<Object>	inboundBuffer
private volatile LocalAddress	localAddress Hides io.netty.channel.AbstractChannel.localAddress.
private static final InternalLogger	logger Hides io.netty.channel.AbstractChannel.logger.
private static final int	MAX_READER_STACK_DEPTH
private static final ChannelMetadata	METADATA
private volatile LocalChannel	peer
private volatile boolean	readInProgress
private final Runnable	readTask
private volatile LocalAddress	remoteAddress Hides io.netty.channel.AbstractChannel.remoteAddress.
private final Runnable	shutdownHook
private volatile LocalChannel.State	state
private volatile boolean	writeInProgress

Constructor Summary

Access	Constructor and Description
public	LocalChannel()
protected	LocalChannel(LocalServerChannel parent, LocalChannel peer)

Method Summary

Modifier and Type	Method and Description
public ChannelConfig	config() Implements io.netty.channel.Channel.config. Returns the configuration of this channel.
protected void	doBeginRead() Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation.
protected void	doBind(SocketAddress localAddress) Implements abstract io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress`
protected void	doClose() Implements abstract io.netty.channel.AbstractChannel.doClose. Close the `Channel`
protected void	doDeregister() Overrides io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`.
protected void	doDisconnect() Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer
protected void	doRegister() Overrides io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
protected void	doWrite(ChannelOutboundBuffer in) Implements abstract io.netty.channel.AbstractChannel.doWrite. Flush the content of the given buffer to the remote peer.
private void	finishPeerRead(final LocalChannel peer)
private void	finishPeerRead0(LocalChannel peer)
public boolean	isActive() Implements io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected.
protected boolean	isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance.
public boolean	isOpen() Implements io.netty.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later
public LocalAddress	localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.Channel.localAddress. Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally.
public ChannelMetadata	metadata() Implements io.netty.channel.Channel.metadata. Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
protected AbstractChannel.AbstractUnsafe	newUnsafe() Implements abstract io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel`
public LocalServerChannel	parent() Overrides io.netty.channel.AbstractChannel.parent. Implements io.netty.channel.Channel.parent. Returns the parent of this channel.
private void	readInbound()
private void	releaseInboundBuffers()
public LocalAddress	remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to.
private void	runFinishPeerReadTask(final LocalChannel peer)
private void	tryClose(boolean isActive)

Field Detail

config	back to summary
private final ChannelConfig config

connectPromise	back to summary
private volatile ChannelPromise connectPromise

FINISH_READ_FUTURE_UPDATER	back to summary
private static final AtomicReferenceFieldUpdater<LocalChannel, Future<V>> FINISH_READ_FUTURE_UPDATER Annotations @SuppressWarnings:rawtypes

finishReadFuture	back to summary
private volatile Future<?> finishReadFuture

inboundBuffer	back to summary
pack-priv final Queue<Object> inboundBuffer

localAddress	back to summary
private volatile LocalAddress localAddress Hides io.netty.channel.AbstractChannel.localAddress.

logger	back to summary
private static final InternalLogger logger Hides io.netty.channel.AbstractChannel.logger.

MAX_READER_STACK_DEPTH	back to summary
private static final int MAX_READER_STACK_DEPTH

METADATA	back to summary
private static final ChannelMetadata METADATA

peer	back to summary
private volatile LocalChannel peer

readInProgress	back to summary
private volatile boolean readInProgress

readTask	back to summary
private final Runnable readTask

remoteAddress	back to summary
private volatile LocalAddress remoteAddress Hides io.netty.channel.AbstractChannel.remoteAddress.

shutdownHook	back to summary
private final Runnable shutdownHook

state	back to summary
private volatile LocalChannel.State state

writeInProgress	back to summary
private volatile boolean writeInProgress

Constructor Detail

LocalChannel	back to summary
public LocalChannel()

LocalChannel	back to summary
protected LocalChannel(LocalServerChannel parent, LocalChannel peer)

Method Detail

config	back to summary
public ChannelConfig config() Implements io.netty.channel.Channel.config. Doc from io.netty.channel.Channel.config. Returns the configuration of this channel. Annotations @Override

config

back to summary

public ChannelConfig config()

Implements io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations

@Override

doBeginRead	back to summary
protected void doBeginRead() throws Exception Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Doc from io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation. Annotations @Override

doBeginRead

back to summary

protected void doBeginRead() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBeginRead.

Doc from io.netty.channel.AbstractChannel.doBeginRead.

Schedule a read operation.

Annotations

@Override

doBind back to summary

doBind	back to summary
protected void doBind(SocketAddress localAddress) throws Exception Implements abstract io.netty.channel.AbstractChannel.doBind. Doc from io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress` Annotations @Override

protected void doBind(SocketAddress localAddress) throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBind.

Doc from io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Annotations

@Override

doClose back to summary

doClose	back to summary
protected void doClose() throws Exception Implements abstract io.netty.channel.AbstractChannel.doClose. Doc from io.netty.channel.AbstractChannel.doClose. Close the `Channel` Annotations @Override

protected void doClose() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doClose.

Doc from io.netty.channel.AbstractChannel.doClose.

Close the Channel

Annotations

@Override

doDeregister back to summary

doDeregister	back to summary
protected void doDeregister() throws Exception Overrides io.netty.channel.AbstractChannel.doDeregister. Doc from io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`. Sub-classes may override this method Annotations @Override

protected void doDeregister() throws Exception

Overrides io.netty.channel.AbstractChannel.doDeregister.

Doc from io.netty.channel.AbstractChannel.doDeregister.

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

Annotations

@Override

doDisconnect back to summary

doDisconnect	back to summary
protected void doDisconnect() throws Exception Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Doc from io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer Annotations @Override

protected void doDisconnect() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doDisconnect.

Doc from io.netty.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer

Annotations

@Override

doRegister back to summary

doRegister	back to summary
protected void doRegister() throws Exception Overrides io.netty.channel.AbstractChannel.doRegister. Doc from io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process. Sub-classes may override this method Annotations @Override

protected void doRegister() throws Exception

Overrides io.netty.channel.AbstractChannel.doRegister.

Doc from io.netty.channel.AbstractChannel.doRegister.

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

Annotations

@Override

doWrite	back to summary
protected void doWrite(ChannelOutboundBuffer in) throws Exception Implements abstract io.netty.channel.AbstractChannel.doWrite. Doc from io.netty.channel.AbstractChannel.doWrite. Flush the content of the given buffer to the remote peer. Annotations @Override

doWrite

back to summary

protected void doWrite(ChannelOutboundBuffer in) throws Exception

Implements abstract io.netty.channel.AbstractChannel.doWrite.

Doc from io.netty.channel.AbstractChannel.doWrite.

Flush the content of the given buffer to the remote peer.

Annotations

@Override

finishPeerRead	back to summary
private void finishPeerRead(final LocalChannel peer)

finishPeerRead0	back to summary
private void finishPeerRead0(LocalChannel peer)

isActive back to summary

isActive	back to summary
public boolean isActive() Implements io.netty.channel.Channel.isActive. Doc from io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected. Annotations @Override

public boolean isActive()

Implements io.netty.channel.Channel.isActive.

Doc from io.netty.channel.Channel.isActive.

Return true if the Channel is active and so connected.

Annotations

@Override

isCompatible back to summary

isCompatible	back to summary
protected boolean isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Doc from io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance. Annotations @Override

protected boolean isCompatible(EventLoop loop)

Implements abstract io.netty.channel.AbstractChannel.isCompatible.

Doc from io.netty.channel.AbstractChannel.isCompatible.

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

Annotations

@Override

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements io.netty.channel.Channel.isOpen. Doc from io.netty.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later Annotations @Override

public boolean isOpen()

Implements io.netty.channel.Channel.isOpen.

Doc from io.netty.channel.Channel.isOpen.

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

Annotations

@Override

localAddress back to summary

localAddress	back to summary
public LocalAddress localAddress() Overrides io.netty.channel.AbstractChannel.localAddress. Implements io.netty.channel.Channel.localAddress. Doc from io.netty.channel.Channel.localAddress. 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. Returns:LocalAddress the local address of this channel. `null` if this channel is not bound. Annotations @Override

public LocalAddress localAddress()

Overrides io.netty.channel.AbstractChannel.localAddress.

Implements io.netty.channel.Channel.localAddress.

Doc from io.netty.channel.Channel.localAddress.

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.

Returns:LocalAddress

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

Annotations

@Override

localAddress0 back to summary

localAddress0	back to summary
protected SocketAddress localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Doc from io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally. Annotations @Override

protected SocketAddress localAddress0()

Implements abstract io.netty.channel.AbstractChannel.localAddress0.

Doc from io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Annotations

@Override

metadata back to summary

public ChannelMetadata metadata()

Implements io.netty.channel.Channel.metadata.

Doc from io.netty.channel.Channel.metadata.

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Annotations

@Override

newUnsafe back to summary

newUnsafe	back to summary
protected AbstractChannel.AbstractUnsafe newUnsafe() Implements abstract io.netty.channel.AbstractChannel.newUnsafe. Doc from io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel` Annotations @Override

protected AbstractChannel.AbstractUnsafe newUnsafe()

Implements abstract io.netty.channel.AbstractChannel.newUnsafe.

Doc from io.netty.channel.AbstractChannel.newUnsafe.

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

Annotations

@Override

parent back to summary

parent	back to summary
public LocalServerChannel parent() Overrides io.netty.channel.AbstractChannel.parent. Implements io.netty.channel.Channel.parent. Doc from io.netty.channel.Channel.parent. Returns the parent of this channel. Returns:LocalServerChannel the parent channel. `null` if this channel does not have a parent channel. Annotations @Override

public LocalServerChannel parent()

Overrides io.netty.channel.AbstractChannel.parent.

Implements io.netty.channel.Channel.parent.

Doc from io.netty.channel.Channel.parent.

Returns the parent of this channel.

Returns:LocalServerChannel

the parent channel. null if this channel does not have a parent channel.

Annotations

@Override

readInbound	back to summary
private void readInbound()

releaseInboundBuffers	back to summary
private void releaseInboundBuffers()

remoteAddress back to summary

remoteAddress	back to summary
public LocalAddress remoteAddress() Overrides io.netty.channel.AbstractChannel.remoteAddress. Implements io.netty.channel.Channel.remoteAddress. Doc from io.netty.channel.Channel.remoteAddress. 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. Returns:LocalAddress 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 `DatagramPacket#recipient()` to determine the origination of the received message as this method will return `null`. Annotations @Override

public LocalAddress remoteAddress()

Overrides io.netty.channel.AbstractChannel.remoteAddress.

Implements io.netty.channel.Channel.remoteAddress.

Doc from io.netty.channel.Channel.remoteAddress.

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.

Returns:LocalAddress

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

Annotations

@Override

remoteAddress0 back to summary

remoteAddress0	back to summary
protected SocketAddress remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Doc from io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to. Annotations @Override

protected SocketAddress remoteAddress0()

Implements abstract io.netty.channel.AbstractChannel.remoteAddress0.

Doc from io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Annotations

@Override

runFinishPeerReadTask	back to summary
private void runFinishPeerReadTask(final LocalChannel peer)

tryClose	back to summary
private void tryClose(boolean isActive)

io.netty.channel.local back to summary

private Class LocalChannel.LocalUnsafe

Class Inheritance

extends AbstractUnsafe

java.lang.Object
io.netty.channel.AbstractChannel.AbstractUnsafe
io.netty.channel.local.LocalChannel.LocalUnsafe

Constructor Summary

Access	Constructor and Description
private	LocalUnsafe()

Method Summary

Modifier and Type	Method and Description
public void	connect(final SocketAddress remoteAddress, SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.Channel.Unsafe.connect. Connect the `Channel` of the given `ChannelFuture` with the given remote `SocketAddress`.

Constructor Detail

LocalUnsafe	back to summary
private LocalUnsafe()

Method Detail

connect back to summary

connect	back to summary
public void connect(final SocketAddress remoteAddress, SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.Channel.Unsafe.connect. Doc from io.netty.channel.Channel.Unsafe.connect. Connect the `Channel` of the given `ChannelFuture` with the given remote `SocketAddress`. If a specific local `SocketAddress` should be used it need to be given as argument. Otherwise just pass `null` to it. The `ChannelPromise` will get notified once the connect operation was complete. Annotations @Override

public void connect(final SocketAddress remoteAddress, SocketAddress localAddress, final ChannelPromise promise)

Implements io.netty.channel.Channel.Unsafe.connect.

Doc from io.netty.channel.Channel.Unsafe.connect.

Connect the Channel of the given ChannelFuture with the given remote SocketAddress. If a specific local SocketAddress should be used it need to be given as argument. Otherwise just pass null to it. The ChannelPromise will get notified once the connect operation was complete.

Annotations

@Override

io.netty.channel.local back to summary

private final Enum LocalChannel.State

Class Inheritance

extends Enum<LocalChannel.State>

java.lang.Object
java.lang.Enum
io.netty.channel.local.LocalChannel.State

Field Summary

Modifier and Type	Field and Description
public static final LocalChannel.State	BOUND
public static final LocalChannel.State	CLOSED
public static final LocalChannel.State	CONNECTED
public static final LocalChannel.State	OPEN

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static LocalChannel.State	valueOf(String name)
public static LocalChannel.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BOUND	back to summary
public static final LocalChannel.State BOUND

CLOSED	back to summary
public static final LocalChannel.State CLOSED

CONNECTED	back to summary
public static final LocalChannel.State CONNECTED

OPEN	back to summary
public static final LocalChannel.State OPEN

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static LocalChannel.State valueOf(String name)

values	back to summary
public static LocalChannel.State[] values()

public Class LocalChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LocalChannel.LocalUnsafe

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Enum LocalChannel.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail