org.jboss.netty.channel.socket.nio

Class NioWorker

java.lang.Object

org.jboss.netty.channel.socket.nio.NioWorker

All Implemented Interfaces:

Runnable, Worker, ExternalResourceReleasable

public class NioWorker
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jboss.netty.channel.socket.nio.SocketSendBufferPool	sendBufferPool
protected Thread	thread If this worker has been started thread will be a reference to the thread used when starting. i.e. the current thread when the run method is executed.
protected AtomicBoolean	wakenUp Boolean that controls determines if a blocked Selector.select should break out of its selection process.
protected Queue<Runnable>	writeTaskQueue Queue of WriteTasks

Constructor Summary

Constructors

Constructor and Description
NioWorker(Executor executor)

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	cleanUpWriteBuffer(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)
protected void	clearOpWrite(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)
protected Runnable	createRegisterTask(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel, ChannelFuture future) Create a new Runnable which will register the AbstractNioWorker with the Channel
void	executeInIoThread(Runnable task) Execute the given Runnable in the IO-Thread.
void	executeInIoThread(Runnable task, boolean alwaysAsync) Execute the Runnable in a IO-Thread
protected boolean	read(SelectionKey k) Read is called when a Selector has been notified that the underlying channel was something to be read.
void	releaseExternalResources() Releases the external resources that this object depends on.
void	run()
protected boolean	scheduleWriteIfNecessary(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)
protected void	setOpWrite(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)
protected void	write0(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

thread

protected volatile Thread thread

If this worker has been started thread will be a reference to the thread used when starting. i.e. the current thread when the run method is executed.

wakenUp

protected final AtomicBoolean wakenUp

Boolean that controls determines if a blocked Selector.select should break out of its selection process. In our case we use a timeone for the select method and the select method will block for that time unless waken up.

writeTaskQueue

protected final Queue<Runnable> writeTaskQueue

Queue of WriteTasks

sendBufferPool

protected final org.jboss.netty.channel.socket.nio.SocketSendBufferPool sendBufferPool

Constructor Detail

NioWorker

public NioWorker(Executor executor)

Method Detail

read

protected boolean read(SelectionKey k)

Read is called when a Selector has been notified that the underlying channel was something to be read. The channel would previously have registered its interest in read operations.

Parameters:

k - The selection key which contains the Selector registration information.

scheduleWriteIfNecessary

protected boolean scheduleWriteIfNecessary(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)

releaseExternalResources

public void releaseExternalResources()

Description copied from interface: ExternalResourceReleasable

Releases the external resources that this object depends on. You should not call this method if the external resources (e.g. thread pool) are in use by other objects.

Specified by:

releaseExternalResources in interface ExternalResourceReleasable

createRegisterTask

protected Runnable createRegisterTask(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel,
                          ChannelFuture future)

Create a new Runnable which will register the AbstractNioWorker with the Channel

Returns:

task

run

public void run()

Specified by:

run in interface Runnable

executeInIoThread

public void executeInIoThread(Runnable task)

Description copied from interface: Worker

Execute the given Runnable in the IO-Thread. This may be now or later once the IO-Thread do some other work.

Specified by:

executeInIoThread in interface Worker

Parameters:

task - the Runnable to execute

executeInIoThread

public void executeInIoThread(Runnable task,
                     boolean alwaysAsync)

Execute the Runnable in a IO-Thread

Parameters:

task - the Runnable to execute

alwaysAsync - true if the Runnable should be executed in an async fashion even if the current Thread == IO Thread

write0

protected void write0(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)

setOpWrite

protected void setOpWrite(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)

clearOpWrite

protected void clearOpWrite(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)

cleanUpWriteBuffer

protected static void cleanUpWriteBuffer(org.jboss.netty.channel.socket.nio.AbstractNioChannel<?> channel)