io.netty.channel.epoll

Class AbstractEpollStreamChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollStreamChannel

All Implemented Interfaces:

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

Direct Known Subclasses:

EpollDomainSocketChannel, EpollSocketChannel

public abstract class AbstractEpollStreamChannel
extends io.netty.channel.AbstractChannel
implements io.netty.channel.socket.DuplexChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	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

Modifier	Constructor and Description
protected	AbstractEpollStreamChannel(io.netty.channel.Channel parent, int fd) Deprecated. Use AbstractEpollStreamChannel(Channel, Socket).
protected	AbstractEpollStreamChannel(io.netty.channel.Channel parent, Socket fd)
protected	AbstractEpollStreamChannel(FileDescriptor fd) Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).
protected	AbstractEpollStreamChannel(int fd) Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).
protected	AbstractEpollStreamChannel(Socket fd) Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).
protected	AbstractEpollStreamChannel(Socket fd, boolean active)

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	checkResolvable(InetSocketAddress addr)
abstract EpollChannelConfig	config()
protected void	doBeginRead()
protected void	doClose()
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 void	doWrite(io.netty.channel.ChannelOutboundBuffer in)
protected int	doWriteBytes(io.netty.buffer.ByteBuf buf, int writeSpinCount)
protected boolean	doWriteSingle(io.netty.channel.ChannelOutboundBuffer in, int writeSpinCount)
Socket	fd() Returns the FileDescriptor that is used by this Channel.
protected Object	filterOutboundMessage(Object msg)
boolean	isActive()
protected boolean	isCompatible(io.netty.channel.EventLoop loop)
boolean	isInputShutdown()
boolean	isOpen()
boolean	isOutputShutdown()
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.ChannelFuture	shutdownOutput()
io.netty.channel.ChannelFuture	shutdownOutput(io.netty.channel.ChannelPromise promise)
protected void	shutdownOutput0(io.netty.channel.ChannelPromise promise)
io.netty.channel.ChannelFuture	spliceTo(AbstractEpollStreamChannel ch, int len) Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel.
io.netty.channel.ChannelFuture	spliceTo(AbstractEpollStreamChannel ch, int len, io.netty.channel.ChannelPromise promise) Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel.
io.netty.channel.ChannelFuture	spliceTo(FileDescriptor ch, int offset, int len) Splice from this AbstractEpollStreamChannel to another FileDescriptor.
io.netty.channel.ChannelFuture	spliceTo(FileDescriptor ch, int offset, int len, io.netty.channel.ChannelPromise promise) Splice from this AbstractEpollStreamChannel to another FileDescriptor.

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, 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

AbstractEpollStreamChannel

@Deprecated
protected AbstractEpollStreamChannel(io.netty.channel.Channel parent,
                                     int fd)

Deprecated. Use AbstractEpollStreamChannel(Channel, Socket).

AbstractEpollStreamChannel

@Deprecated
protected AbstractEpollStreamChannel(int fd)

Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).

AbstractEpollStreamChannel

@Deprecated
protected AbstractEpollStreamChannel(FileDescriptor fd)

Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).

AbstractEpollStreamChannel

@Deprecated
protected AbstractEpollStreamChannel(Socket fd)

Deprecated. Use AbstractEpollStreamChannel(Socket, boolean).

AbstractEpollStreamChannel

protected AbstractEpollStreamChannel(io.netty.channel.Channel parent,
                          Socket fd)

AbstractEpollStreamChannel

protected AbstractEpollStreamChannel(Socket fd,
                          boolean active)

Method Detail

newUnsafe

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

spliceTo

public final io.netty.channel.ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                      int len)

Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:

• both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
• EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel

spliceTo

public final io.netty.channel.ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                      int len,
                                      io.netty.channel.ChannelPromise promise)

Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:

• both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
• EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel

spliceTo

public final io.netty.channel.ChannelFuture spliceTo(FileDescriptor ch,
                                      int offset,
                                      int len)

Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:

• EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
• the FileDescriptor will not be closed after the ChannelFuture is notified
• this channel must be registered to an event loop or IllegalStateException will be thrown.

spliceTo

public final io.netty.channel.ChannelFuture spliceTo(FileDescriptor ch,
                                      int offset,
                                      int len,
                                      io.netty.channel.ChannelPromise promise)

Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:

• EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
• the FileDescriptor will not be closed after the ChannelPromise is notified
• this channel must be registered to an event loop or IllegalStateException will be thrown.

doWrite

protected void doWrite(io.netty.channel.ChannelOutboundBuffer in)
                throws Exception

Specified by:

doWrite in class io.netty.channel.AbstractChannel

Throws:

Exception

doWriteSingle

protected boolean doWriteSingle(io.netty.channel.ChannelOutboundBuffer in,
                    int writeSpinCount)
                         throws Exception

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Overrides:

filterOutboundMessage in class io.netty.channel.AbstractChannel

shutdownOutput0

protected void shutdownOutput0(io.netty.channel.ChannelPromise promise)

isInputShutdown

public boolean isInputShutdown()

Specified by:

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

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

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

shutdownOutput

public io.netty.channel.ChannelFuture shutdownOutput()

Specified by:

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

shutdownOutput

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

Specified by:

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

doClose

protected void doClose()
                throws Exception

Throws:

Exception

doConnect

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

Connect to the remote peer

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

config

public abstract EpollChannelConfig config()

Specified by:

config in interface io.netty.channel.Channel

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