io.netty.channel.epoll

Class EpollSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollStreamChannel

io.netty.channel.epoll.EpollSocketChannel

All Implemented Interfaces:

Channel, SocketChannel, UnixChannel, AttributeMap, Comparable<Channel>

public final class EpollSocketChannel
extends AbstractEpollStreamChannel
implements SocketChannel

SocketChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

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

Constructor and Description
EpollSocketChannel()
EpollSocketChannel(FileDescriptor fd) Creates a new EpollSocketChannel from an existing FileDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	checkResolvable(InetSocketAddress addr)
EpollSocketChannelConfig	config() Returns the configuration of this channel.
protected void	doBeginRead() Schedule a read operation.
protected void	doBind(SocketAddress local) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, 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 int	doWriteBytes(ByteBuf buf, int writeSpinCount)
FileDescriptor	fd() Returns the FileDescriptor that is used by this Channel.
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	isInputShutdown() Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.
boolean	isOpen() Returns true if the Channel is open an may get active later
boolean	isOutputShutdown()
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected 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(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
ServerSocketChannel	parent() Returns the parent of this channel.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise promise)
EpollTcpInfo	tcpInfo() Returns the TCP_INFO for the current socket.
EpollTcpInfo	tcpInfo(EpollTcpInfo info) Updates and returns the TCP_INFO for the current socket.

Methods inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

doWrite, doWriteSingle, filterOutboundMessage, isInputShutdown0, isOutputShutdown0, shutdownOutput0

Methods inherited from class io.netty.channel.AbstractChannel

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

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

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, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

flags

protected int flags

active

protected volatile boolean active

Constructor Detail

EpollSocketChannel

public EpollSocketChannel()

EpollSocketChannel

public EpollSocketChannel(FileDescriptor fd)

Creates a new EpollSocketChannel from an existing FileDescriptor.

Method Detail

tcpInfo

public EpollTcpInfo tcpInfo()

Returns the TCP_INFO for the current socket. See man 7 tcp.

tcpInfo

public EpollTcpInfo tcpInfo(EpollTcpInfo info)

Updates and returns the TCP_INFO for the current socket. See man 7 tcp.

remoteAddress

public InetSocketAddress 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

Specified by:

remoteAddress in interface SocketChannel

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

localAddress

public InetSocketAddress 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

Specified by:

localAddress in interface SocketChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

doBind

protected void doBind(SocketAddress local)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

Exception

config

public EpollSocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface SocketChannel

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: SocketChannel

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

Specified by:

isInputShutdown in interface SocketChannel

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface SocketChannel

See Also:

Socket.isOutputShutdown()

shutdownOutput

public ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Socket.shutdownOutput()

shutdownOutput

public ChannelFuture shutdownOutput(ChannelPromise promise)

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Will notify the given {@link ChannelPromise}

parent

public ServerSocketChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Specified by:

parent in interface SocketChannel

Overrides:

parent in class AbstractChannel

Returns:

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

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

Overrides:

newUnsafe in class AbstractEpollStreamChannel

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                SocketAddress localAddress)
                     throws Exception

Description copied from class: AbstractEpollStreamChannel

Connect to the remote peer

Overrides:

doConnect in class AbstractEpollStreamChannel

Throws:

Exception

fd

public final FileDescriptor fd()

Description copied from interface: UnixChannel

Returns the FileDescriptor that is used by this Channel.

Specified by:

fd in interface UnixChannel

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 Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

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

isOpen

public boolean isOpen()

Description copied from interface: Channel

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

Specified by:

isOpen in interface Channel

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

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

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(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(InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

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

Throws:

Exception