io.netty.channel.epoll

Class AbstractEpollServerChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollServerChannel

All Implemented Interfaces:

Channel, ServerChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

Direct Known Subclasses:

EpollServerDomainSocketChannel, EpollServerSocketChannel

public abstract class AbstractEpollServerChannel
extends AbstractChannel
implements ServerChannel

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

Modifier and Type	Field and Description
protected boolean	active
protected int	flags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEpollServerChannel(FileDescriptor fd) Deprecated. Use AbstractEpollServerChannel(Socket, boolean).
protected	AbstractEpollServerChannel(int fd) Deprecated. Use AbstractEpollServerChannel(Socket, boolean).
protected	AbstractEpollServerChannel(Socket fd) Deprecated. Use AbstractEpollServerChannel(Socket, boolean).
protected	AbstractEpollServerChannel(Socket fd, boolean active)

Method Summary

Modifier and Type	Method and Description
protected static void	checkResolvable(java.net.InetSocketAddress addr)
abstract EpollChannelConfig	config() Returns the configuration of this channel.
protected void	doBeginRead() Schedule a read operation.
protected void	doBind(java.net.SocketAddress local) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected boolean	doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) Connect to the remote peer
protected void	doDeregister() Deregister the Channel from its EventLoop.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadBytes(ByteBuf byteBuf) Read bytes into the given ByteBuf and return the amount.
protected void	doRegister() Is called after the Channel is registered with its EventLoop as part of the register process.
protected void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
protected int	doWriteBytes(ByteBuf buf, int writeSpinCount)
Socket	fd() Returns the FileDescriptor that is used by this Channel.
protected java.lang.Object	filterOutboundMessage(java.lang.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.
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
protected java.net.SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected ByteBuf	newDirectBuffer(ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected ByteBuf	newDirectBuffer(java.lang.Object holder, ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe	newUnsafe() Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected java.net.InetSocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

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.channel.Channel

alloc, bind, bind, close, close, closeFuture, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, isActive, isOpen, isRegistered, isWritable, localAddress, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

flags

protected int flags

active

protected volatile boolean active

Constructor Detail

AbstractEpollServerChannel

@Deprecated
protected AbstractEpollServerChannel(int fd)

Deprecated. Use AbstractEpollServerChannel(Socket, boolean).

AbstractEpollServerChannel

@Deprecated
protected AbstractEpollServerChannel(FileDescriptor fd)

Deprecated. Use AbstractEpollServerChannel(Socket, boolean).

AbstractEpollServerChannel

@Deprecated
protected AbstractEpollServerChannel(Socket fd)

Deprecated. Use AbstractEpollServerChannel(Socket, boolean).

AbstractEpollServerChannel

protected AbstractEpollServerChannel(Socket fd,
                                     boolean active)

Method Detail

isCompatible

protected boolean isCompatible(EventLoop loop)

Description copied from class: AbstractChannel

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

remoteAddress0

protected java.net.InetSocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

newUnsafe

protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()

Description copied from class: AbstractChannel

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

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception

Description copied from class: AbstractChannel

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

Specified by:

doWrite in class AbstractChannel

Throws:

java.lang.Exception

filterOutboundMessage

protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
                                          throws java.lang.Exception

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

Throws:

java.lang.Exception

doConnect

protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception

Connect to the remote peer

Throws:

java.lang.Exception

fd

public final Socket fd()

Description copied from interface: UnixChannel

Returns the FileDescriptor that is used by this Channel.

Specified by:

fd in interface UnixChannel

config

public abstract EpollChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

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

Specified by:

metadata in interface Channel

doClose

protected void doClose()
                throws java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

java.lang.Exception

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.Exception

isOpen

public boolean isOpen()

Description copied from interface: Channel

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

Specified by:

isOpen in interface Channel

doDeregister

protected void doDeregister()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

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

Overrides:

doDeregister in class AbstractChannel

Throws:

java.lang.Exception

doBeginRead

protected void doBeginRead()
                    throws java.lang.Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

java.lang.Exception

doRegister

protected void doRegister()
                   throws java.lang.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:

java.lang.Exception

newDirectBuffer

protected final ByteBuf newDirectBuffer(ByteBuf buf)

Returns an off-heap copy of the specified ByteBuf, and releases the original one.

newDirectBuffer

protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        ByteBuf buf)

Returns an off-heap copy of the specified ByteBuf, and releases the specified holder. The caller must ensure that the holder releases the original ByteBuf when the holder is released by this method.

checkResolvable

protected static void checkResolvable(java.net.InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

java.lang.Exception

doWriteBytes

protected final int doWriteBytes(ByteBuf buf,
                                 int writeSpinCount)
                          throws java.lang.Exception

Throws:

java.lang.Exception

doBind

protected void doBind(java.net.SocketAddress local)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

java.lang.Exception

localAddress0

protected java.net.SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel