Package io.netty.channel.epoll
Class EpollServerSocketChannel
- java.lang.Object
-
- io.netty.util.DefaultAttributeMap
-
- io.netty.channel.AbstractChannel
-
- io.netty.channel.epoll.AbstractEpollServerChannel
-
- io.netty.channel.epoll.EpollServerSocketChannel
-
- All Implemented Interfaces:
Channel
,ChannelOutboundInvoker
,ServerChannel
,ServerSocketChannel
,UnixChannel
,AttributeMap
,java.lang.Comparable<Channel>
public final class EpollServerSocketChannel extends AbstractEpollServerChannel implements ServerSocketChannel
ServerSocketChannel
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 Description protected boolean
active
protected LinuxSocket
socket
-
Constructor Summary
Constructors Constructor Description EpollServerSocketChannel()
EpollServerSocketChannel(int fd)
EpollServerSocketChannel(InternetProtocolFamily protocol)
Deprecated.EpollServerSocketChannel(SocketProtocolFamily protocol)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static void
checkResolvable(java.net.InetSocketAddress addr)
EpollServerSocketChannelConfig
config()
Returns the configuration of this channel.protected void
doBeginRead()
Schedule a read operation.protected void
doBind(java.net.SocketAddress localAddress)
Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected void
doDeregister()
protected void
doDisconnect()
Disconnect thisChannel
from its remote peerprotected int
doReadBytes(ByteBuf byteBuf)
Read bytes into the givenByteBuf
and return the amount.protected void
doRegister(ChannelPromise promise)
protected int
doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)
FileDescriptor
fd()
Returns theFileDescriptor
that is used by thisChannel
.boolean
isActive()
Returntrue
if theChannel
is active and so connected.protected boolean
isCompatible(EventLoop loop)
Returntrue
if the givenEventLoop
is compatible with this instance.boolean
isOpen()
Returnstrue
if theChannel
is open and may get active laterjava.net.InetSocketAddress
localAddress()
Returns the local address where this channel is bound to.protected java.net.SocketAddress
localAddress0()
Returns theSocketAddress
which is bound locally.protected Channel
newChildChannel(int fd, byte[] address, int offset, int len)
protected ByteBuf
newDirectBuffer(ByteBuf buf)
Returns an off-heap copy of the specifiedByteBuf
, and releases the original one.protected ByteBuf
newDirectBuffer(java.lang.Object holder, ByteBuf buf)
Returns an off-heap copy of the specifiedByteBuf
, and releases the specified holder.protected IoRegistration
registration()
java.net.InetSocketAddress
remoteAddress()
Returns the remote address where this channel is connected to.protected void
setFlag(int flag)
-
Methods inherited from class io.netty.channel.epoll.AbstractEpollServerChannel
doConnect, doWrite, filterOutboundMessage, metadata, newUnsafe, remoteAddress0
-
Methods inherited from class io.netty.channel.AbstractChannel
closeFuture, compareTo, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, toString, unsafe, validateFileRegion, voidPromise
-
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.util.AttributeMap
attr, hasAttr
-
Methods inherited from interface io.netty.channel.Channel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush
-
-
-
-
Field Detail
-
socket
protected final LinuxSocket socket
-
active
protected volatile boolean active
-
-
Constructor Detail
-
EpollServerSocketChannel
public EpollServerSocketChannel()
-
EpollServerSocketChannel
@Deprecated public EpollServerSocketChannel(InternetProtocolFamily protocol)
Deprecated.
-
EpollServerSocketChannel
public EpollServerSocketChannel(SocketProtocolFamily protocol)
-
EpollServerSocketChannel
public EpollServerSocketChannel(int fd)
-
-
Method Detail
-
doBind
protected void doBind(java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Throws:
java.lang.Exception
-
remoteAddress
public java.net.InetSocketAddress remoteAddress()
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Specified by:
remoteAddress
in interfaceServerSocketChannel
- Overrides:
remoteAddress
in classAbstractChannel
- 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
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
localAddress
public java.net.InetSocketAddress localAddress()
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Specified by:
localAddress
in interfaceServerSocketChannel
- Overrides:
localAddress
in classAbstractChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
config
public EpollServerSocketChannelConfig config()
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceServerSocketChannel
-
newChildChannel
protected Channel newChildChannel(int fd, byte[] address, int offset, int len) throws java.lang.Exception
- Specified by:
newChildChannel
in classAbstractEpollServerChannel
- Throws:
java.lang.Exception
-
setFlag
protected void setFlag(int flag) throws java.io.IOException
- Throws:
java.io.IOException
-
registration
protected final IoRegistration registration()
-
fd
public final FileDescriptor fd()
Description copied from interface:UnixChannel
Returns theFileDescriptor
that is used by thisChannel
.- Specified by:
fd
in interfaceUnixChannel
-
isActive
public boolean isActive()
Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected.
-
doClose
protected void doClose() throws java.lang.Exception
Description copied from class:AbstractChannel
Close theChannel
- Specified by:
doClose
in classAbstractChannel
- Throws:
java.lang.Exception
-
doDisconnect
protected void doDisconnect() throws java.lang.Exception
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Specified by:
doDisconnect
in classAbstractChannel
- Throws:
java.lang.Exception
-
isOpen
public boolean isOpen()
Description copied from interface:Channel
Returnstrue
if theChannel
is open and may get active later
-
doDeregister
protected void doDeregister() throws java.lang.Exception
Description copied from class:AbstractChannel
- Overrides:
doDeregister
in classAbstractChannel
- Throws:
java.lang.Exception
-
isCompatible
protected boolean isCompatible(EventLoop loop)
Description copied from class:AbstractChannel
Returntrue
if the givenEventLoop
is compatible with this instance.- Specified by:
isCompatible
in classAbstractChannel
-
doBeginRead
protected void doBeginRead() throws java.lang.Exception
Description copied from class:AbstractChannel
Schedule a read operation.- Specified by:
doBeginRead
in classAbstractChannel
- Throws:
java.lang.Exception
-
doRegister
protected void doRegister(ChannelPromise promise)
Description copied from class:AbstractChannel
Is called after theChannel
is registered with itsEventLoop
as part of the register process. Subclasses may override this method- Overrides:
doRegister
in classAbstractChannel
- Parameters:
promise
-ChannelPromise
that must be notified once done to continue the registration.
-
newDirectBuffer
protected final ByteBuf newDirectBuffer(ByteBuf buf)
Returns an off-heap copy of the specifiedByteBuf
, and releases the original one.
-
checkResolvable
protected static void checkResolvable(java.net.InetSocketAddress addr)
-
doReadBytes
protected final int doReadBytes(ByteBuf byteBuf) throws java.lang.Exception
Read bytes into the givenByteBuf
and return the amount.- Throws:
java.lang.Exception
-
doWriteBytes
protected final int doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf) throws java.lang.Exception
- Throws:
java.lang.Exception
-
localAddress0
protected java.net.SocketAddress localAddress0()
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
-