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:

AbstractKQueueDatagramChannel, AbstractKQueueServerChannel, AbstractKQueueStreamChannel
```
abstract class AbstractKQueueChannel
extends AbstractChannel
implements UnixChannel
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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	Description
`protected boolean`	`active`
`private ChannelPromise`	`connectPromise`	The future of the current connection attempt.
`private Future<?>`	`connectTimeoutFuture`
`(package private) boolean`	`inputClosedSeenErrorOnRead`
`private java.net.SocketAddress`	`local`
`private static ChannelMetadata`	`METADATA`
`private boolean`	`readFilterEnabled`
`(package private) boolean`	`readReadyRunnablePending`
`(package private) KQueueEventLoop.KQueueRegistration`	`registration`
`private java.net.SocketAddress`	`remote`
`private java.net.SocketAddress`	`requestedRemoteAddress`
`(package private) BsdSocket`	`socket`
`private boolean`	`writeFilterEnabled`

Constructor Summary

Constructors
Constructor	Description
`AbstractKQueueChannel(Channel parent, BsdSocket fd, boolean active)`
`AbstractKQueueChannel(Channel parent, BsdSocket fd, java.net.SocketAddress remote)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`private void`	`clearRdHup0()`
`(package private) void`	`clearReadFilter()`
`abstract KQueueChannelConfig`	`config()`	Returns the configuration of this channel.
`protected void`	`doBeginRead()`	Schedule a read operation.
`protected void`	`doBind(java.net.SocketAddress local)`	Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()`	Close the `Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)`	Connect to the remote peer
`protected boolean`	`doConnect0(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)`
`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(ChannelOutboundBuffer in, ByteBuf buf)`
`private void`	`evSet(short filter, short flags)`
`private void`	`evSet0(short filter, short flags)`
`private void`	`evSet0(short filter, short flags, int fflags)`
`FileDescriptor`	`fd()`	Returns the `FileDescriptor` that is used by this `Channel`.
`boolean`	`isActive()`	Return `true` if the `Channel` is active and so connected.
`private static 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)`
`protected java.net.SocketAddress`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`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)`
`protected java.net.SocketAddress`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.
`(package private) void`	`resetCachedAddresses()`
`(package private) boolean`	`shouldBreakReadReady(ChannelConfig config)`
`(package private) void`	`unregisterFilters()`
`(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, doShutdownOutput, doWrite, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, validateFileRegion, 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.util.AttributeMap
attr, hasAttr

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

connectPromise
```
private ChannelPromise connectPromise
```
The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture
```
private Future<?> connectTimeoutFuture
```

requestedRemoteAddress

private java.net.SocketAddress requestedRemoteAddress

socket
```
final BsdSocket socket
```

readFilterEnabled
```
private boolean readFilterEnabled
```

writeFilterEnabled
```
private boolean writeFilterEnabled
```

registration

KQueueEventLoop.KQueueRegistration registration

readReadyRunnablePending
```
boolean readReadyRunnablePending
```

inputClosedSeenErrorOnRead
```
boolean inputClosedSeenErrorOnRead
```

active
```
protected volatile boolean active
```

local

private volatile java.net.SocketAddress local

remote

private volatile java.net.SocketAddress remote

Constructor Detail

AbstractKQueueChannel

AbstractKQueueChannel(Channel parent,
                      BsdSocket fd,
                      boolean active)

AbstractKQueueChannel

AbstractKQueueChannel(Channel parent,
                      BsdSocket fd,
                      java.net.SocketAddress remote)

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
- resetCachedAddresses
```
void resetCachedAddresses()
```
- 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
- unregisterFilters
```
void unregisterFilters()
                throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- clearRdHup0
```
private void clearRdHup0()
```
- 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(ChannelOutboundBuffer in,
                                 ByteBuf buf)
                          throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- shouldBreakReadReady
```
final boolean shouldBreakReadReady(ChannelConfig config)
```
- isAllowHalfClosure
```
private static 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)
```
- evSet0
```
private void evSet0(short filter,
                    short flags,
                    int fflags)
```
- 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
- doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
  Connect to the remote peer
  
  Throws:
  
  java.lang.Exception
- doConnect0
```
protected boolean doConnect0(java.net.SocketAddress remoteAddress,
                             java.net.SocketAddress localAddress)
                      throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- 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

Class AbstractKQueueChannel

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

Field Detail

METADATA

connectPromise

connectTimeoutFuture

requestedRemoteAddress

socket

readFilterEnabled

writeFilterEnabled

registration

readReadyRunnablePending

inputClosedSeenErrorOnRead

active

local

remote

Constructor Detail

AbstractKQueueChannel

AbstractKQueueChannel

Method Detail

isSoErrorZero

fd

isActive

metadata

doClose

doDisconnect

resetCachedAddresses

isCompatible

isOpen

doDeregister

unregisterFilters

clearRdHup0

doBeginRead

doRegister

newUnsafe

config

newDirectBuffer

newDirectBuffer

newDirectBuffer0

checkResolvable

doReadBytes

doWriteBytes

shouldBreakReadReady

isAllowHalfClosure

clearReadFilter

readFilter

writeFilter

evSet

evSet0

evSet0

doBind

doConnect

doConnect0

localAddress0

remoteAddress0