io.netty.channel.local

Class LocalChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.local.LocalChannel

All Implemented Interfaces:

Channel, ChannelFutureFactory, ChannelOutboundInvoker, io.netty.util.AttributeMap, 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

Field Summary

Fields inherited from class io.netty.channel.AbstractChannel

flushFutureNotifier

Constructor Summary

Constructors

Constructor and Description
LocalChannel()
LocalChannel(Integer id)

Method Summary

Methods

Modifier and Type	Method and Description
ChannelConfig	config() Returns the configuration of this channel.
protected void	doBind(SocketAddress localAddress)
protected void	doClose()
protected void	doDeregister()
protected void	doDisconnect()
protected void	doFlushMessageBuffer(io.netty.buffer.MessageBuf<Object> buf)
protected void	doPreClose()
protected Runnable	doRegister()
boolean	isActive()
protected boolean	isCompatible(EventLoop loop)
protected boolean	isFlushPending()
boolean	isOpen()
LocalAddress	localAddress() Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0()
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected Channel.Unsafe	newUnsafe()
LocalServerChannel	parent() Returns the parent of this channel.
LocalAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0()

Methods inherited from class io.netty.channel.AbstractChannel

bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doFlushByteBuffer, equals, eventLoop, flush, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, newFailedFuture, newFuture, newSucceededFuture, outboundByteBuffer, outboundMessageBuffer, pipeline, toString, unsafe, write, write

Methods inherited from class io.netty.util.DefaultAttributeMap

attr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.AttributeMap

attr

Constructor Detail

LocalChannel

public LocalChannel()

LocalChannel

public LocalChannel(Integer id)

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

isOpen

public boolean isOpen()

isActive

public boolean isActive()

newUnsafe

protected Channel.Unsafe newUnsafe()

Specified by:

newUnsafe in class AbstractChannel

isCompatible

protected boolean isCompatible(EventLoop loop)

Specified by:

isCompatible in class AbstractChannel

localAddress0

protected SocketAddress localAddress0()

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Specified by:

remoteAddress0 in class AbstractChannel

doRegister

protected Runnable doRegister()
                       throws Exception

Specified by:

doRegister in class AbstractChannel

Throws:

Exception

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Specified by:

doBind in class AbstractChannel

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doPreClose

protected void doPreClose()
                   throws Exception

Overrides:

doPreClose in class AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doDeregister

protected void doDeregister()
                     throws Exception

Specified by:

doDeregister in class AbstractChannel

Throws:

Exception

doFlushMessageBuffer

protected void doFlushMessageBuffer(io.netty.buffer.MessageBuf<Object> buf)
                             throws Exception

Overrides:

doFlushMessageBuffer in class AbstractChannel

Throws:

Exception

isFlushPending

protected boolean isFlushPending()

Specified by:

isFlushPending in class AbstractChannel