org.jboss.netty.channel.socket.nio

Class AbstractNioChannel<C extends java.nio.channels.SelectableChannel & java.nio.channels.WritableByteChannel>

java.lang.Object

org.jboss.netty.channel.AbstractChannel

org.jboss.netty.channel.socket.nio.AbstractNioChannel<C>

All Implemented Interfaces:

java.lang.Comparable<Channel>, Channel

Direct Known Subclasses:

NioDatagramChannel, NioSocketChannel

abstract class AbstractNioChannel<C extends java.nio.channels.SelectableChannel & java.nio.channels.WritableByteChannel>
extends AbstractChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AbstractNioChannel.WriteRequestQueue
private class	AbstractNioChannel.WriteTask

Field Summary

Fields

Modifier and Type	Field and Description
(package private) C	channel
(package private) SocketSendBufferPool.SendBuffer	currentWriteBuffer
(package private) MessageEvent	currentWriteEvent The current write MessageEvent
(package private) java.util.concurrent.atomic.AtomicInteger	highWaterMarkCounter Keeps track of the highWaterMark.
(package private) boolean	inWriteNowLoop Boolean that indicates that write operation is in progress.
private java.net.InetSocketAddress	localAddress
(package private) java.net.InetSocketAddress	remoteAddress
(package private) AbstractNioWorker	worker The AbstractNioWorker.
(package private) AbstractNioChannel.WriteRequestQueue	writeBufferQueue Queue of write MessageEvents.
(package private) java.util.concurrent.atomic.AtomicInteger	writeBufferSize Keeps track of the number of bytes that the AbstractNioChannel.WriteRequestQueue currently contains.
(package private) java.lang.Object	writeLock Monitor object for synchronizing access to the AbstractNioChannel.WriteRequestQueue.
(package private) boolean	writeSuspended
(package private) java.lang.Runnable	writeTask WriteTask that performs write operations.
(package private) java.util.concurrent.atomic.AtomicBoolean	writeTaskInTaskQueue Indicates if there is a AbstractNioChannel.WriteTask in the task queue.

Fields inherited from interface org.jboss.netty.channel.Channel

OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNioChannel(Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, AbstractNioWorker worker, C ch)
protected	AbstractNioChannel(java.lang.Integer id, Channel parent, ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, AbstractNioWorker worker, C ch)

Method Summary

Modifier and Type	Method and Description
abstract NioChannelConfig	getConfig() Returns the configuration of this channel.
protected int	getInternalInterestOps()
java.net.InetSocketAddress	getLocalAddress() Returns the local address where this channel is bound to.
(package private) abstract java.net.InetSocketAddress	getLocalSocketAddress()
java.net.InetSocketAddress	getRemoteAddress() Returns the remote address where this channel is connected to.
(package private) abstract java.net.InetSocketAddress	getRemoteSocketAddress()
AbstractNioWorker	getWorker() Return the AbstractNioWorker that handle the IO of the AbstractNioChannel
protected boolean	setClosed() Marks this channel as closed.
protected void	setInternalInterestOps(int interestOps) Sets the interestOps property of this channel immediately.

Methods inherited from class org.jboss.netty.channel.AbstractChannel

bind, close, compareTo, connect, disconnect, equals, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getSucceededFuture, getUnsupportedOperationFuture, getUserDefinedWritability, hashCode, isOpen, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUnwritable, setUserDefinedWritability, setWritable, toString, unbind, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.netty.channel.Channel

isBound, isConnected

Field Detail

worker

final AbstractNioWorker worker

The AbstractNioWorker.

writeLock

final java.lang.Object writeLock

Monitor object for synchronizing access to the AbstractNioChannel.WriteRequestQueue.

writeTask

final java.lang.Runnable writeTask

WriteTask that performs write operations.

writeTaskInTaskQueue

final java.util.concurrent.atomic.AtomicBoolean writeTaskInTaskQueue

Indicates if there is a AbstractNioChannel.WriteTask in the task queue.

writeBufferQueue

final AbstractNioChannel.WriteRequestQueue writeBufferQueue

Queue of write MessageEvents.

writeBufferSize

final java.util.concurrent.atomic.AtomicInteger writeBufferSize

Keeps track of the number of bytes that the AbstractNioChannel.WriteRequestQueue currently contains.

highWaterMarkCounter

final java.util.concurrent.atomic.AtomicInteger highWaterMarkCounter

Keeps track of the highWaterMark.

currentWriteEvent

MessageEvent currentWriteEvent

The current write MessageEvent

currentWriteBuffer

SocketSendBufferPool.SendBuffer currentWriteBuffer

inWriteNowLoop

boolean inWriteNowLoop

Boolean that indicates that write operation is in progress.

writeSuspended

boolean writeSuspended

localAddress

private volatile java.net.InetSocketAddress localAddress

remoteAddress

volatile java.net.InetSocketAddress remoteAddress

channel

final C extends java.nio.channels.SelectableChannel & java.nio.channels.WritableByteChannel channel

Constructor Detail

AbstractNioChannel

protected AbstractNioChannel(java.lang.Integer id,
                             Channel parent,
                             ChannelFactory factory,
                             ChannelPipeline pipeline,
                             ChannelSink sink,
                             AbstractNioWorker worker,
                             C ch)

AbstractNioChannel

protected AbstractNioChannel(Channel parent,
                             ChannelFactory factory,
                             ChannelPipeline pipeline,
                             ChannelSink sink,
                             AbstractNioWorker worker,
                             C ch)

Method Detail

getWorker

public AbstractNioWorker getWorker()

Return the AbstractNioWorker that handle the IO of the AbstractNioChannel

Returns:

worker

getLocalAddress

public java.net.InetSocketAddress getLocalAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Returns:

the local address of this channel. null if this channel is not bound.

getRemoteAddress

public java.net.InetSocketAddress getRemoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

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, use MessageEvent.getRemoteAddress() to determine the origination of the received message as this method will return null.

getConfig

public abstract NioChannelConfig getConfig()

Description copied from interface: Channel

Returns the configuration of this channel.

getInternalInterestOps

protected int getInternalInterestOps()

Overrides:

getInternalInterestOps in class AbstractChannel

setInternalInterestOps

protected void setInternalInterestOps(int interestOps)

Description copied from class: AbstractChannel

Sets the interestOps property of this channel immediately. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.

Overrides:

setInternalInterestOps in class AbstractChannel

setClosed

protected boolean setClosed()

Description copied from class: AbstractChannel

Marks this channel as closed. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.

Overrides:

setClosed in class AbstractChannel

Returns:

true if and only if this channel was not marked as closed yet

getLocalSocketAddress

abstract java.net.InetSocketAddress getLocalSocketAddress()
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getRemoteSocketAddress

abstract java.net.InetSocketAddress getRemoteSocketAddress()
                                                    throws java.lang.Exception

Throws:

java.lang.Exception