org.glassfish.grizzly.nio
Class AbstractNIOAsyncQueueWriter

java.lang.Object
  org.glassfish.grizzly.AbstractWriter<SocketAddress>
      org.glassfish.grizzly.nio.AbstractNIOAsyncQueueWriter

All Implemented Interfaces:

AsyncQueue, AsyncQueueWriter<SocketAddress>, Writer<SocketAddress>

Direct Known Subclasses:

TCPNIOAsyncQueueWriter, UDPNIOAsyncQueueWriter

public abstract class AbstractNIOAsyncQueueWriter
extends AbstractWriter<SocketAddress>
implements AsyncQueueWriter<SocketAddress>

The AsyncQueueWriter implementation, based on the Java NIO

Author:

Alexey Stashok, Ryan Lubke, Gustav Trede

Field Summary

protected int	maxPendingBytes
protected int	maxWriteReenterants
protected NIOTransport	transport

Constructor Summary

AbstractNIOAsyncQueueWriter(NIOTransport transport)

Method Summary

boolean	canWrite(Connection connection, int size)
void	close() Close AsyncQueueProcessor and release associated resources
protected AsyncWriteQueueRecord	createRecord(Connection connection, Buffer message, Future<WriteResult<Buffer,SocketAddress>> future, WriteResult<Buffer,SocketAddress> currentResult, CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler, Interceptor<WriteResult<Buffer,SocketAddress>> interceptor, SocketAddress dstAddress, Buffer outputBuffer, boolean isCloned, boolean isEmptyRecord)
protected void	failWriteRecord(AsyncWriteQueueRecord record, Throwable e)
int	getMaxPendingBytesPerConnection()
int	getMaxWriteReenterants() Returns the maximum number of write() method reenterants a thread is allowed to made.
boolean	isReady(Connection connection) Checks whether there is ready data in AsyncQueue, associated with the Connection.
void	onClose(Connection connection) Callback method, which is called, when Connection has been closed, to let processor release a connection associated resources.
protected abstract void	onReadyToWrite(Connection connection)
protected void	onWriteComplete(AsyncWriteQueueRecord record)
protected void	onWriteFailure(Connection connection, AsyncWriteQueueRecord failedRecord, IOException e)
protected void	onWriteIncomplete(AsyncWriteQueueRecord record)
void	processAsync(Connection connection) Callback method, which is called async.
void	setMaxPendingBytesPerConnection(int maxPendingBytes) Configures the maximum number of bytes pending to be written for a particular Connection.
void	setMaxWriteReenterants(int maxWriteReenterants) Sets the maximum number of write() method reenterants a thread is allowed to made.
GrizzlyFuture<WriteResult<Buffer,SocketAddress>>	write(Connection connection, SocketAddress dstAddress, Buffer buffer, CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler, Interceptor<WriteResult<Buffer,SocketAddress>> interceptor) Method writes the buffer to the specific address.
GrizzlyFuture<WriteResult<Buffer,SocketAddress>>	write(Connection connection, SocketAddress dstAddress, Buffer buffer, CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler, Interceptor<WriteResult<Buffer,SocketAddress>> interceptor, MessageCloner<Buffer> cloner) Method writes the Buffer to the specific address.
protected abstract int	write0(NIOConnection connection, AsyncWriteQueueRecord queueRecord)

Methods inherited from class org.glassfish.grizzly.AbstractWriter

write, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.grizzly.Writer

write, write, write, write

Field Detail

transport

protected final NIOTransport transport

maxPendingBytes

protected volatile int maxPendingBytes

maxWriteReenterants

protected volatile int maxWriteReenterants

Constructor Detail

AbstractNIOAsyncQueueWriter

public AbstractNIOAsyncQueueWriter(NIOTransport transport)

Method Detail

canWrite

public boolean canWrite(Connection connection,
                        int size)

Specified by:

canWrite in interface AsyncQueueWriter<SocketAddress>

Parameters:

connection - the Connection to test whether or not the specified number of bytes can be written to.

size - number of bytes to write.

Returns:

true if the queue has not exceeded it's maximum size in bytes of pending writes, otherwise false

setMaxPendingBytesPerConnection

public void setMaxPendingBytesPerConnection(int maxPendingBytes)

Configures the maximum number of bytes pending to be written for a particular Connection.

Specified by:

setMaxPendingBytesPerConnection in interface AsyncQueueWriter<SocketAddress>

Parameters:

maxPendingBytes - maximum number of pending writes that may be queued for a particular Connection

getMaxPendingBytesPerConnection

public int getMaxPendingBytesPerConnection()

Specified by:

getMaxPendingBytesPerConnection in interface AsyncQueueWriter<SocketAddress>

Returns:

the maximum number of bytes that may be pending to be written to a particular Connection.

getMaxWriteReenterants

public int getMaxWriteReenterants()

Returns the maximum number of write() method reenterants a thread is allowed to made. This is related to possible write()->onComplete()->write()->... chain, which may grow infinitely and cause StackOverflow. Using maxWriteReeenterants value it's possible to limit such a chain.

Specified by:

getMaxWriteReenterants in interface AsyncQueueWriter<SocketAddress>

Returns:

the maximum number of write() method reenterants a thread is allowed to made.

setMaxWriteReenterants

public void setMaxWriteReenterants(int maxWriteReenterants)

Sets the maximum number of write() method reenterants a thread is allowed to made. This is related to possible write()->onComplete()->write()->... chain, which may grow infinitely and cause StackOverflow. Using maxWriteReeenterants value it's possible to limit such a chain.

Specified by:

setMaxWriteReenterants in interface AsyncQueueWriter<SocketAddress>

Parameters:

maxWriteReenterants - the maximum number of write() method reenterants a thread is allowed to made.

write

public GrizzlyFuture<WriteResult<Buffer,SocketAddress>> write(Connection connection,
                                                              SocketAddress dstAddress,
                                                              Buffer buffer,
                                                              CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler,
                                                              Interceptor<WriteResult<Buffer,SocketAddress>> interceptor)
                                                       throws IOException

Description copied from interface: Writer

Method writes the buffer to the specific address.

Specified by:

write in interface Writer<SocketAddress>

Parameters:

connection - the Connection to write to

dstAddress - the destination address the buffer will be sent to

buffer - the buffer, from which the data will be written

completionHandler - CompletionHandler, which will get notified, when write will be completed

interceptor - Interceptor, which will be able to intercept control each time new portion of a data was written from a buffer. The interceptor can decide, whether asynchronous write is completed or not, or provide other processing instructions.

Returns:

Future, using which it's possible to check the result

Throws:

IOException

write

public GrizzlyFuture<WriteResult<Buffer,SocketAddress>> write(Connection connection,
                                                              SocketAddress dstAddress,
                                                              Buffer buffer,
                                                              CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler,
                                                              Interceptor<WriteResult<Buffer,SocketAddress>> interceptor,
                                                              MessageCloner<Buffer> cloner)
                                                       throws IOException

Method writes the Buffer to the specific address.

Specified by:

write in interface AsyncQueueWriter<SocketAddress>

Parameters:

connection - the Connection to write to

dstAddress - the destination address the message will be sent to

buffer - the Buffer from which the data will be written

completionHandler - CompletionHandler, which will get notified, when write will be completed

interceptor - Interceptor, which will be able to intercept control each time new portion of a data was written from a buffer. The interceptor can decide, whether asynchronous write is completed or not, or provide other processing instructions.

cloner - MessageCloner, which will be invoked by AsyncQueueWriter, if message could not be written to a channel directly and has to be put on a asynchronous queue

Returns:

Future, using which it's possible to check the result

Throws:

IOException

createRecord

protected AsyncWriteQueueRecord createRecord(Connection connection,
                                             Buffer message,
                                             Future<WriteResult<Buffer,SocketAddress>> future,
                                             WriteResult<Buffer,SocketAddress> currentResult,
                                             CompletionHandler<WriteResult<Buffer,SocketAddress>> completionHandler,
                                             Interceptor<WriteResult<Buffer,SocketAddress>> interceptor,
                                             SocketAddress dstAddress,
                                             Buffer outputBuffer,
                                             boolean isCloned,
                                             boolean isEmptyRecord)

isReady

public final boolean isReady(Connection connection)

Checks whether there is ready data in AsyncQueue, associated with the Connection.

Specified by:

isReady in interface AsyncQueue

Parameters:

connection - Connection

Returns:

true, if there is ready data, or false otherwise.

processAsync

public void processAsync(Connection connection)
                  throws IOException

Callback method, which is called async. to process ready AsyncQueue, which are associated with the given Connection

Specified by:

processAsync in interface AsyncQueue

Parameters:

connection - Connection

Throws:

IOException

onClose

public void onClose(Connection connection)

Callback method, which is called, when Connection has been closed, to let processor release a connection associated resources.

Specified by:

onClose in interface AsyncQueue

Parameters:

connection - Connection

close

public final void close()

Close AsyncQueueProcessor and release associated resources

Specified by:

close in interface AsyncQueue

onWriteComplete

protected final void onWriteComplete(AsyncWriteQueueRecord record)
                              throws IOException

Throws:

IOException

onWriteIncomplete

protected final void onWriteIncomplete(AsyncWriteQueueRecord record)
                                throws IOException

Throws:

IOException

onWriteFailure

protected final void onWriteFailure(Connection connection,
                                    AsyncWriteQueueRecord failedRecord,
                                    IOException e)

failWriteRecord

protected final void failWriteRecord(AsyncWriteQueueRecord record,
                                     Throwable e)

write0

protected abstract int write0(NIOConnection connection,
                              AsyncWriteQueueRecord queueRecord)
                       throws IOException

Throws:

IOException

onReadyToWrite

protected abstract void onReadyToWrite(Connection connection)
                                throws IOException

Throws:

IOException