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:

io.netty.channel.Channel, io.netty.channel.socket.SocketChannel, UnixChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>

public final class EpollSocketChannel
extends AbstractEpollStreamChannel
implements io.netty.channel.socket.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.epoll.AbstractEpollStreamChannel

AbstractEpollStreamChannel.SpliceInTask

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

io.netty.channel.AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

io.netty.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) Deprecated. Use EpollSocketChannel(Socket, boolean).
EpollSocketChannel(Socket fd, boolean active) 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()
protected void	doBeginRead()
protected void	doBind(SocketAddress local)
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer
protected void	doDeregister()
protected void	doDisconnect()
protected int	doReadBytes(io.netty.buffer.ByteBuf byteBuf) Read bytes into the given ByteBuf and return the amount.
protected void	doRegister()
protected int	doWriteBytes(io.netty.buffer.ByteBuf buf, int writeSpinCount)
Socket	fd() Returns the FileDescriptor that is used by this Channel.
boolean	isActive()
protected boolean	isCompatible(io.netty.channel.EventLoop loop)
boolean	isInputShutdown()
boolean	isOpen()
boolean	isOutputShutdown()
InetSocketAddress	localAddress()
protected SocketAddress	localAddress0()
io.netty.channel.ChannelMetadata	metadata()
protected io.netty.buffer.ByteBuf	newDirectBuffer(io.netty.buffer.ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected io.netty.buffer.ByteBuf	newDirectBuffer(Object holder, io.netty.buffer.ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe	newUnsafe()
io.netty.channel.socket.ServerSocketChannel	parent()
InetSocketAddress	remoteAddress()
protected SocketAddress	remoteAddress0()
io.netty.channel.ChannelFuture	shutdownOutput()
io.netty.channel.ChannelFuture	shutdownOutput(io.netty.channel.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

doClose, doWrite, doWriteSingle, filterOutboundMessage, shutdownOutput0, spliceTo, spliceTo, spliceTo, spliceTo

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, 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

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, 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

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

@Deprecated
public EpollSocketChannel(FileDescriptor fd)

Deprecated. Use EpollSocketChannel(Socket, boolean).

EpollSocketChannel

public EpollSocketChannel(Socket fd,
                  boolean active)

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

Specified by:

remoteAddress in interface io.netty.channel.Channel

Specified by:

remoteAddress in interface io.netty.channel.socket.SocketChannel

Overrides:

remoteAddress in class io.netty.channel.AbstractChannel

localAddress

public InetSocketAddress localAddress()

Specified by:

localAddress in interface io.netty.channel.Channel

Specified by:

localAddress in interface io.netty.channel.socket.SocketChannel

Overrides:

localAddress in class io.netty.channel.AbstractChannel

localAddress0

protected SocketAddress localAddress0()

Specified by:

localAddress0 in class io.netty.channel.AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Specified by:

remoteAddress0 in class io.netty.channel.AbstractChannel

doBind

protected void doBind(SocketAddress local)
               throws Exception

Specified by:

doBind in class io.netty.channel.AbstractChannel

Throws:

Exception

config

public EpollSocketChannelConfig config()

Specified by:

config in interface io.netty.channel.Channel

Specified by:

config in interface io.netty.channel.socket.SocketChannel

isInputShutdown

public boolean isInputShutdown()

Specified by:

isInputShutdown in interface io.netty.channel.socket.SocketChannel

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface io.netty.channel.socket.SocketChannel

shutdownOutput

public io.netty.channel.ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface io.netty.channel.socket.SocketChannel

shutdownOutput

public io.netty.channel.ChannelFuture shutdownOutput(io.netty.channel.ChannelPromise promise)

Specified by:

shutdownOutput in interface io.netty.channel.socket.SocketChannel

parent

public io.netty.channel.socket.ServerSocketChannel parent()

Specified by:

parent in interface io.netty.channel.Channel

Specified by:

parent in interface io.netty.channel.socket.SocketChannel

Overrides:

parent in class io.netty.channel.AbstractChannel

newUnsafe

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

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 Socket 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()

Specified by:

isActive in interface io.netty.channel.Channel

metadata

public io.netty.channel.ChannelMetadata metadata()

Specified by:

metadata in interface io.netty.channel.Channel

doDisconnect

protected void doDisconnect()
                     throws Exception

Specified by:

doDisconnect in class io.netty.channel.AbstractChannel

Throws:

Exception

isCompatible

protected boolean isCompatible(io.netty.channel.EventLoop loop)

Specified by:

isCompatible in class io.netty.channel.AbstractChannel

isOpen

public boolean isOpen()

Specified by:

isOpen in interface io.netty.channel.Channel

doDeregister

protected void doDeregister()
                     throws Exception

Overrides:

doDeregister in class io.netty.channel.AbstractChannel

Throws:

Exception

doBeginRead

protected void doBeginRead()
                    throws Exception

Specified by:

doBeginRead in class io.netty.channel.AbstractChannel

Throws:

Exception

doRegister

protected void doRegister()
                   throws Exception

Overrides:

doRegister in class io.netty.channel.AbstractChannel

Throws:

Exception

newDirectBuffer

protected final io.netty.buffer.ByteBuf newDirectBuffer(io.netty.buffer.ByteBuf buf)

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

newDirectBuffer

protected final io.netty.buffer.ByteBuf newDirectBuffer(Object holder,
                                      io.netty.buffer.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(io.netty.buffer.ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

protected final int doWriteBytes(io.netty.buffer.ByteBuf buf,
               int writeSpinCount)
                          throws Exception

Throws:

Exception