io.netty.channel.epoll

Class EpollSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollChannel

io.netty.channel.epoll.AbstractEpollStreamChannel

io.netty.channel.epoll.EpollSocketChannel

All Implemented Interfaces:

Channel, DuplexChannel, SocketChannel, UnixChannel, AttributeMap, java.lang.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

Modifier and Type	Class and Description
private class	EpollSocketChannel.EpollSocketChannelUnsafe

Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

AbstractEpollStreamChannel.EpollStreamUnsafe, AbstractEpollStreamChannel.SpliceInTask

Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollChannel

AbstractEpollChannel.AbstractEpollUnsafe

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
private EpollSocketChannelConfig	config
private java.net.InetSocketAddress	local
private java.net.InetSocketAddress	remote
private java.net.InetSocketAddress	requestedRemote
private java.util.Collection<java.net.InetAddress>	tcpMd5SigAddresses

Fields inherited from class io.netty.channel.epoll.AbstractEpollChannel

active, flags

Constructor Summary

Constructors

Constructor and Description
EpollSocketChannel()
EpollSocketChannel(Channel parent, Socket fd, java.net.InetSocketAddress remote)
EpollSocketChannel(FileDescriptor fd) Deprecated. Use EpollSocketChannel(Socket, boolean).
EpollSocketChannel(Socket fd, boolean active) Creates a new EpollSocketChannel from an existing FileDescriptor.

Method Summary

Modifier and Type	Method and Description
private static java.net.InetSocketAddress	computeRemoteAddr(java.net.InetSocketAddress remoteAddr, java.net.InetSocketAddress osRemoteAddr)
EpollSocketChannelConfig	config() Returns the configuration of this channel.
protected void	doBind(java.net.SocketAddress local) Bind the Channel to the SocketAddress
protected boolean	doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) Connect to the remote peer
java.net.InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected java.net.SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
protected 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.
java.net.InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected java.net.SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
(package private) void	setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)
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, isInputShutdown, isOutputShutdown, shutdownOutput, shutdownOutput, shutdownOutput0, spliceTo, spliceTo, spliceTo, spliceTo

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

checkResolvable, clearEpollIn, clearFlag, doBeginRead, doDeregister, doDisconnect, doReadBytes, doRegister, doWriteBytes, fd, isActive, isCompatible, isFlagSet, isOpen, isSoErrorZero, metadata, newDirectBuffer, newDirectBuffer, setFlag

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, newChannelPipeline, 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.socket.DuplexChannel

isInputShutdown, isOutputShutdown, shutdownOutput, shutdownOutput

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

config

private final EpollSocketChannelConfig config

local

private volatile java.net.InetSocketAddress local

remote

private volatile java.net.InetSocketAddress remote

requestedRemote

private java.net.InetSocketAddress requestedRemote

tcpMd5SigAddresses

private volatile java.util.Collection<java.net.InetAddress> tcpMd5SigAddresses

Constructor Detail

EpollSocketChannel

EpollSocketChannel(Channel parent,
                   Socket fd,
                   java.net.InetSocketAddress remote)

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 java.net.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 java.net.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 java.net.SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected java.net.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(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

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

Specified by:

config in class AbstractEpollChannel

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

computeRemoteAddr

private static java.net.InetSocketAddress computeRemoteAddr(java.net.InetSocketAddress remoteAddr,
                                                            java.net.InetSocketAddress osRemoteAddr)

doConnect

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

Description copied from class: AbstractEpollStreamChannel

Connect to the remote peer

Overrides:

doConnect in class AbstractEpollStreamChannel

Throws:

java.lang.Exception

setTcpMd5Sig

void setTcpMd5Sig(java.util.Map<java.net.InetAddress,byte[]> keys)
           throws java.io.IOException

Throws:

java.io.IOException