Class LocalServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.AbstractServerChannel

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

Modifier and Type	Class	Description
protected class	AbstractChannel.AbstractUnsafe	Channel.Unsafe implementation which sub-classes must extend and use.

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

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()	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.
LocalAddress	remoteAddress()	Returns the remote address where this channel is connected to.

Methods inherited from class AbstractServerChannel

doDisconnect, doWrite, filterOutboundMessage, metadata, newUnsafe, remoteAddress0

Modifier and Type	Method	Description
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected final Object	filterOutboundMessage(Object msg)	Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
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
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.

Methods inherited from class AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
ChannelFuture	bind(SocketAddress localAddress)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	bind(SocketAddress localAddress, ChannelPromise promise)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
ChannelFuture	connect(SocketAddress remoteAddress)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
protected void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
final boolean	equals(Object o)	Returns true if and only if the specified object is identical with this channel (i.e: this == o).
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
final int	hashCode()	Returns the ID of this channel.
final ChannelId	id()	Returns the globally unique identifier of this Channel.
protected void	invalidateLocalAddress()	Deprecated. no use-case for this.
protected void	invalidateRemoteAddress()	Deprecated. no use-case for this.
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
protected final int	maxMessagesPerWrite()
protected DefaultChannelPipeline	newChannelPipeline()	Returns a new DefaultChannelPipeline instance.
ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
ChannelPromise	newPromise()	Return a new ChannelPromise.
ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
Channel	parent()	Returns the parent of this channel.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
Channel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
String	toString()	Returns the String representation of this channel.
Channel.Unsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.
protected void	validateFileRegion(DefaultFileRegion region, long position)
final ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from class Object

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

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()
                   throws Exception

Description copied from class: AbstractChannel

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

Overrides:

doRegister in class AbstractChannel

Throws:

Exception

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.