Package 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.grizzly.asyncqueue.AsyncQueue

AsyncQueue.AsyncResult

Nested classes/interfaces inherited from interface org.glassfish.grizzly.Writer

Writer.Reentrant

Field Summary

Fields

Modifier and Type	Field	Description
protected int	maxPendingBytes
protected int	maxWriteReentrants
protected NIOTransport	transport

Fields inherited from interface org.glassfish.grizzly.asyncqueue.AsyncQueue

EXPECTING_MORE_OPTION

Fields inherited from interface org.glassfish.grizzly.asyncqueue.AsyncQueueWriter

AUTO_SIZE, UNLIMITED_SIZE

Constructor Summary

Constructors

Constructor	Description
AbstractNIOAsyncQueueWriter(NIOTransport transport)

Method Summary

Modifier and Type	Method	Description
protected AsyncWriteQueueRecord	aggregate(TaskQueue<AsyncWriteQueueRecord> connectionQueue)	Aggregates records in a queue to be written as one chunk.
boolean	canWrite(Connection<SocketAddress> connection)	Return true if the connection has not exceeded it's maximum size in bytes of pending writes, otherwise false.
boolean	canWrite(Connection<SocketAddress> connection, int size)	Deprecated.
void	close()	Close AsyncQueueProcessor and release associated resources
protected AsyncWriteQueueRecord	createRecord(Connection connection, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler, SocketAddress dstAddress, PushBackHandler pushBackHandler, boolean isUncountable)
int	getMaxPendingBytesPerConnection()
boolean	isAllowDirectWrite()	Returns true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.
boolean	isReady(Connection connection)	Checks whether there is ready data in AsyncQueue, associated with the Connection.
void	notifyWritePossible(Connection<SocketAddress> connection, WriteHandler writeHandler)	Registers WriteHandler, which will be notified ones at least one byte can be written.
void	notifyWritePossible(Connection<SocketAddress> connection, WriteHandler writeHandler, int size)	Deprecated.
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(NIOConnection connection)
protected static void	onWriteFailure(Connection connection, AsyncWriteQueueRecord failedRecord, Throwable e)
AsyncQueue.AsyncResult	processAsync(Context context)	Callback method, which is called async.
void	setAllowDirectWrite(boolean isAllowDirectWrite)	Set true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.
void	setMaxPendingBytesPerConnection(int maxPendingBytes)	Configures the maximum number of bytes pending to be written for a particular Connection.
void	write(Connection<SocketAddress> connection, SocketAddress dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler, MessageCloner<WritableMessage> cloner)	Method writes the WritableMessage to the specific address.
void	write(Connection<SocketAddress> connection, SocketAddress dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler, PushBackHandler pushBackHandler)	Deprecated.
void	write(Connection<SocketAddress> connection, SocketAddress dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler, PushBackHandler pushBackHandler, MessageCloner<WritableMessage> cloner)	Deprecated.
protected abstract RecordWriteResult	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

maxWriteReentrants

protected volatile int maxWriteReentrants

Constructor Detail

AbstractNIOAsyncQueueWriter

public AbstractNIOAsyncQueueWriter(NIOTransport transport)

Method Detail

canWrite

@Deprecated
public boolean canWrite(Connection<SocketAddress> connection,
                        int size)

Deprecated.

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

canWrite

public boolean canWrite(Connection<SocketAddress> connection)

Description copied from interface: Writer

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

Specified by:

canWrite in interface Writer<SocketAddress>

Parameters:

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

Returns:

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

notifyWritePossible

@Deprecated
public void notifyWritePossible(Connection<SocketAddress> connection,
                                WriteHandler writeHandler,
                                int size)

Deprecated.

Registers WriteHandler, which will be notified ones the Connection is able to accept more bytes to be written. Note: using this method from different threads simultaneously may lead to quick situation changes, so at time WriteHandler is called - the queue may become busy again.

Specified by:

notifyWritePossible in interface AsyncQueueWriter<SocketAddress>

Parameters:

connection - Connection

writeHandler - WriteHandler to be notified.

size - number of bytes queue has to be able to accept before notifying WriteHandler.

notifyWritePossible

public void notifyWritePossible(Connection<SocketAddress> connection,
                                WriteHandler writeHandler)

Description copied from interface: Writer

Registers WriteHandler, which will be notified ones at least one byte can be written. This method call is equivalent to call notifyWritePossible(connection, writeHandler, 1); Note: using this method from different threads simultaneously may lead to quick situation changes, so at time WriteHandler is called - the queue may become busy again.

Specified by:

notifyWritePossible in interface Writer<SocketAddress>

Parameters:

connection - Connection

writeHandler - WriteHandler to be notified.

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 bytes that may be pending to be written to 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. By default, this will be four times the size of the Socket send buffer size.

isAllowDirectWrite

public boolean isAllowDirectWrite()

Returns true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.

Specified by:

isAllowDirectWrite in interface AsyncQueueWriter<SocketAddress>

Returns:

true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.

setAllowDirectWrite

public void setAllowDirectWrite(boolean isAllowDirectWrite)

Set true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.

Specified by:

setAllowDirectWrite in interface AsyncQueueWriter<SocketAddress>

Parameters:

isAllowDirectWrite - true, if async write queue is allowed to write buffer directly during write(...) method call, w/o adding buffer to the queue, or false otherwise.

write

public void write(Connection<SocketAddress> connection,
                  SocketAddress dstAddress,
                  WritableMessage message,
                  CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler,
                  MessageCloner<WritableMessage> cloner)

Description copied from interface: Writer

Method writes the WritableMessage to the specific address.

Specified by:

write in interface Writer<SocketAddress>

Parameters:

connection - the Connection to write to

dstAddress - the destination address the WritableMessage will be sent to

message - the WritableMessage, from which the data will be written

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

cloner - the MessageCloner, which will be able to clone the message in case it can't be completely written in the current thread.

write

@Deprecated
public void write(Connection<SocketAddress> connection,
                  SocketAddress dstAddress,
                  WritableMessage message,
                  CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler,
                  PushBackHandler pushBackHandler)

Deprecated.

Description copied from interface: Writer

Method writes the WritableMessage to the specific address.

Specified by:

write in interface Writer<SocketAddress>

Parameters:

connection - the Connection to write to

dstAddress - the destination address the WritableMessage will be sent to

message - the WritableMessage, from which the data will be written

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

pushBackHandler - PushBackHandler, which will be notified if message was accepted by transport write queue or refused

write

@Deprecated
public void write(Connection<SocketAddress> connection,
                  SocketAddress dstAddress,
                  WritableMessage message,
                  CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler,
                  PushBackHandler pushBackHandler,
                  MessageCloner<WritableMessage> cloner)

Deprecated.

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 WritableMessage will be sent to

message - the WritableMessage, from which the data will be written

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

pushBackHandler - PushBackHandler, which will be notified if message was accepted by transport write queue or refused

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

processAsync

public AsyncQueue.AsyncResult processAsync(Context context)

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

Specified by:

processAsync in interface AsyncQueue

Parameters:

context - Context

Returns:

AsyncQueue.AsyncResult, depending on async queue status.

createRecord

protected AsyncWriteQueueRecord createRecord(Connection connection,
                                             WritableMessage message,
                                             CompletionHandler<WriteResult<WritableMessage,SocketAddress>> completionHandler,
                                             SocketAddress dstAddress,
                                             PushBackHandler pushBackHandler,
                                             boolean isUncountable)

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.

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

onWriteFailure

protected static void onWriteFailure(Connection connection,
                                     AsyncWriteQueueRecord failedRecord,
                                     Throwable e)

write0

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

Throws:

IOException

onReadyToWrite

protected abstract void onReadyToWrite(NIOConnection connection)
                                throws IOException

Throws:

IOException

aggregate

protected AsyncWriteQueueRecord aggregate(TaskQueue<AsyncWriteQueueRecord> connectionQueue)

Aggregates records in a queue to be written as one chunk.