io.netty.channel.kqueue

Class AbstractKQueueStreamChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.kqueue.AbstractKQueueStreamChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, UnixChannel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

KQueueDomainSocketChannel, KQueueSocketChannel

@UnstableApi
public abstract class AbstractKQueueStreamChannel
extends AbstractChannel
implements DuplexChannel

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 and Description
protected boolean	active

Method Summary

Modifier and Type	Method and Description
protected static void	checkResolvable(InetSocketAddress addr)
abstract KQueueChannelConfig	config() Returns the configuration of this channel.
protected void	doBeginRead() Schedule a read operation.
protected void	doClose() Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer
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 void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
protected int	doWriteBytes(ByteBuf buf, int writeSpinCount)
protected boolean	doWriteSingle(ChannelOutboundBuffer in, int writeSpinCount)
FileDescriptor	fd() Returns the FileDescriptor that is used by this Channel.
protected Object	filterOutboundMessage(Object msg) Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
boolean	isActive() Return true if the Channel is active and so connected.
protected boolean	isCompatible(EventLoop loop) Return true if the given EventLoop is compatible with this instance.
boolean	isInputShutdown() Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.
boolean	isOpen() Returns true if the Channel is open and may get active later
boolean	isOutputShutdown()
boolean	isShutdown() Determine if both the input and output of this channel have been shutdown.
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(Object holder, ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe	newUnsafe() Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
ChannelFuture	shutdown() Will shutdown the input and output sides of this channel.
ChannelFuture	shutdown(ChannelPromise promise) Will shutdown the input and output sides of this channel.
ChannelFuture	shutdownInput()
ChannelFuture	shutdownInput(ChannelPromise promise) Will shutdown the input and notify ChannelPromise.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise promise) Will shutdown the output and notify ChannelPromise.

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, equals, eventLoop, 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, config, eventLoop, flush, id, isActive, isOpen, 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

active

protected volatile boolean active

Method Detail

newUnsafe

protected io.netty.channel.kqueue.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

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

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

doWriteSingle

protected boolean doWriteSingle(ChannelOutboundBuffer in,
                                int writeSpinCount)
                         throws Exception

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface DuplexChannel

See Also:

Socket.isOutputShutdown()

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: DuplexChannel

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

Specified by:

isInputShutdown in interface DuplexChannel

isShutdown

public boolean isShutdown()

Description copied from interface: DuplexChannel

Determine if both the input and output of this channel have been shutdown.

Specified by:

isShutdown in interface DuplexChannel

shutdownOutput

public ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

Socket.shutdownOutput()

shutdownOutput

public ChannelFuture shutdownOutput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the output and notify ChannelPromise.

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

Socket.shutdownOutput()

shutdownInput

public ChannelFuture shutdownInput()

Specified by:

shutdownInput in interface DuplexChannel

See Also:

Socket.shutdownInput()

shutdownInput

public ChannelFuture shutdownInput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and notify ChannelPromise.

Specified by:

shutdownInput in interface DuplexChannel

See Also:

Socket.shutdownInput()

shutdown

public ChannelFuture shutdown()

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Returns:

will be completed when both shutdown operations complete.

shutdown

public ChannelFuture shutdown(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Parameters:

promise - will be completed when both shutdown operations complete.

Returns:

will be completed when both shutdown operations complete.

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Throws:

Exception

doConnect

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

Connect to the remote peer

Throws:

Exception

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

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

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 Exception

Description copied from class: AbstractChannel

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

Overrides:

doDeregister in class AbstractChannel

Throws:

Exception

doBeginRead

protected final void doBeginRead()
                          throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

Exception

doRegister

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

Exception

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

checkResolvable

protected static void checkResolvable(InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

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

Throws:

Exception