Netty/Transport 4.1.107.Final · io.netty.channel.local.LocalServerChannel

Modifier and Type	Field and Description
private volatile boolean	acceptInProgress
private final ChannelConfig	config
private final Queue<Object>	inboundBuffer
private volatile LocalAddress	localAddress Hides io.netty.channel.AbstractChannel.localAddress.
private final Runnable	shutdownHook
private volatile int	state

Access	Constructor and Description
public	LocalServerChannel()

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	doRegister() Overrides io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
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.
protected LocalChannel	newLocalChannel(LocalChannel peer) A factory method for `LocalChannel`s.
private void	readInbound()
public LocalAddress	remoteAddress() Overrides io.netty.channel.AbstractServerChannel.remoteAddress. Implements io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to.
pack-priv LocalChannel	serve(final LocalChannel peer)
private void	serve0(final LocalChannel child)

Inherited from io.netty.channel.AbstractServerChannel:: doDisconnect doWrite filterOutboundMessage metadata newUnsafe remoteAddress0

acceptInProgress	back to summary
private volatile boolean acceptInProgress

config	back to summary
private final ChannelConfig config

inboundBuffer	back to summary
private final Queue<Object> inboundBuffer

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

shutdownHook	back to summary
private final Runnable shutdownHook

state	back to summary
private volatile int state

LocalServerChannel	back to summary
public LocalServerChannel()

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

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

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

newLocalChannel	back to summary
protected LocalChannel newLocalChannel(LocalChannel peer) A factory method for `LocalChannel`s. Users may override it to create custom instances of `LocalChannel`s.

readInbound	back to summary
private void readInbound()

remoteAddress back to summary

remoteAddress	back to summary
public LocalAddress remoteAddress() Overrides io.netty.channel.AbstractServerChannel.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.AbstractServerChannel.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

serve	back to summary
pack-priv LocalChannel serve(final LocalChannel peer)

serve0	back to summary
private void serve0(final LocalChannel child)

public Class LocalServerChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail