io.netty.channel.kqueue

Class AbstractKQueueChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.kqueue.AbstractKQueueChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

Direct Known Subclasses:

AbstractKQueueServerChannel, AbstractKQueueStreamChannel, KQueueDatagramChannel

abstract class AbstractKQueueChannel
extends AbstractChannel
implements UnixChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AbstractKQueueChannel.AbstractKQueueUnsafe

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
(package private) boolean	inputClosedSeenErrorOnRead
(package private) long	jniSelfPtr This member variable means we don't have to have a map in KQueueEventLoop which associates the FDs from kqueue to instances of this class.
private static ChannelMetadata	METADATA
private boolean	readFilterEnabled
(package private) boolean	readReadyRunnablePending
(package private) BsdSocket	socket
private boolean	writeFilterEnabled

Constructor Summary

Constructors

Constructor and Description
AbstractKQueueChannel(Channel parent, BsdSocket fd, boolean active)
AbstractKQueueChannel(Channel parent, BsdSocket fd, boolean active, boolean writeFilterEnabled)

Method Summary

Modifier and Type	Method and Description
protected static void	checkResolvable(java.net.InetSocketAddress addr)
(package private) void	clearReadFilter()
abstract KQueueChannelConfig	config() Returns the configuration of this channel.
protected void	doBeginRead() Schedule a read operation.
protected void	doClose() Close the Channel
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)
private void	evSet(short filter, short flags)
private void	evSet0(short filter, short flags)
FileDescriptor	fd() Returns the FileDescriptor that is used by this Channel.
boolean	isActive() Return true if the Channel is active and so connected.
(package private) boolean	isAllowHalfClosure(ChannelConfig config)
protected boolean	isCompatible(EventLoop loop) Return true if the given EventLoop is compatible with this instance.
boolean	isOpen() Returns true if the Channel is open and may get active later
(package private) static boolean	isSoErrorZero(BsdSocket fd)
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(java.lang.Object holder, ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
private static ByteBuf	newDirectBuffer0(java.lang.Object holder, ByteBuf buf, ByteBufAllocator alloc, int capacity)
protected abstract AbstractKQueueChannel.AbstractKQueueUnsafe	newUnsafe() Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
(package private) void	readFilter(boolean readFilterEnabled)
(package private) boolean	shouldBreakReadReady(ChannelConfig config)
(package private) void	writeFilter(boolean writeFilterEnabled)

Methods inherited from class io.netty.channel.AbstractChannel

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

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

METADATA

private static final ChannelMetadata METADATA

socket

final BsdSocket socket

readFilterEnabled

private boolean readFilterEnabled

writeFilterEnabled

private boolean writeFilterEnabled

readReadyRunnablePending

boolean readReadyRunnablePending

inputClosedSeenErrorOnRead

boolean inputClosedSeenErrorOnRead

jniSelfPtr

long jniSelfPtr

This member variable means we don't have to have a map in KQueueEventLoop which associates the FDs from kqueue to instances of this class. This field will be initialized by JNI when modifying kqueue events. If there is no global reference when JNI gets a kqueue evSet call (aka this field is 0) then a global reference will be created and the address will be saved in this member variable. Then when we process a kevent in Java we can ask JNI to give us the AbstractKQueueChannel that corresponds to that event.

active

protected volatile boolean active

Constructor Detail

AbstractKQueueChannel

AbstractKQueueChannel(Channel parent,
                      BsdSocket fd,
                      boolean active)

AbstractKQueueChannel

AbstractKQueueChannel(Channel parent,
                      BsdSocket fd,
                      boolean active,
                      boolean writeFilterEnabled)

Method Detail

isSoErrorZero

static boolean isSoErrorZero(BsdSocket fd)

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 java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

java.lang.Exception

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.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 and may get active later

Specified by:

isOpen in interface Channel

doDeregister

protected void doDeregister()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Deregister the Channel from its EventLoop. Sub-classes may override this method

Overrides:

doDeregister in class AbstractChannel

Throws:

java.lang.Exception

doBeginRead

protected final void doBeginRead()
                          throws java.lang.Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

java.lang.Exception

doRegister

protected void doRegister()
                   throws java.lang.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:

java.lang.Exception

newUnsafe

protected abstract AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractChannel

config

public abstract KQueueChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

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(java.lang.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.

newDirectBuffer0

private static ByteBuf newDirectBuffer0(java.lang.Object holder,
                                        ByteBuf buf,
                                        ByteBufAllocator alloc,
                                        int capacity)

checkResolvable

protected static void checkResolvable(java.net.InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

java.lang.Exception

doWriteBytes

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

Throws:

java.lang.Exception

shouldBreakReadReady

final boolean shouldBreakReadReady(ChannelConfig config)

isAllowHalfClosure

final boolean isAllowHalfClosure(ChannelConfig config)

clearReadFilter

final void clearReadFilter()

readFilter

void readFilter(boolean readFilterEnabled)
         throws java.io.IOException

Throws:

java.io.IOException

writeFilter

void writeFilter(boolean writeFilterEnabled)
          throws java.io.IOException

Throws:

java.io.IOException

evSet

private void evSet(short filter,
                   short flags)

evSet0

private void evSet0(short filter,
                    short flags)