org.glassfish.grizzly

Interface Writer<L>

Type Parameters:

L - the writer address type

All Known Subinterfaces:

AsyncQueueWriter<L>

All Known Implementing Classes:

AbstractNIOAsyncQueueWriter, AbstractWriter, TCPNIOAsyncQueueWriter, TCPNIOTemporarySelectorWriter, TemporarySelectorWriter, UDPNIOAsyncQueueWriter, UDPNIOTemporarySelectorWriter

public interface Writer<L>

Implementations of this interface are able to write data from a Buffer to Connection. There are two basic Writer implementations in Grizzly: AsyncQueueWriter, TemporarySelectorWriter.

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Writer.Reentrant Write reentrants counter

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(Connection<L> connection) Return true if the connection has not exceeded it's maximum size in bytes of pending writes, otherwise false.
void	notifyWritePossible(Connection<L> connection, WriteHandler writeHandler) Registers WriteHandler, which will be notified ones at least one byte can be written.
GrizzlyFuture<WriteResult<WritableMessage,L>>	write(Connection<L> connection, L dstAddress, WritableMessage message) Method writes the WritableMessage to the specific address.
void	write(Connection<L> connection, L dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,L>> completionHandler) Method writes the WritableMessage to the specific address.
void	write(Connection<L> connection, L dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,L>> completionHandler, MessageCloner<WritableMessage> messageCloner) Method writes the WritableMessage to the specific address.
void	write(Connection<L> connection, L dstAddress, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,L>> completionHandler, PushBackHandler pushBackHandler) Deprecated. push back logic is deprecated
GrizzlyFuture<WriteResult<WritableMessage,L>>	write(Connection<L> connection, WritableMessage message) Method writes the WritableMessage.
void	write(Connection<L> connection, WritableMessage message, CompletionHandler<WriteResult<WritableMessage,L>> completionHandler) Method writes the WritableMessage.

Method Detail

write

GrizzlyFuture<WriteResult<WritableMessage,L>> write(Connection<L> connection,
                                                    WritableMessage message)
                                             throws IOException

Method writes the WritableMessage.

Parameters:

connection - the Connection to write to

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

Returns:

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

Throws:

IOException - not thrown

write

void write(Connection<L> connection,
           WritableMessage message,
           CompletionHandler<WriteResult<WritableMessage,L>> completionHandler)

Method writes the WritableMessage.

Parameters:

connection - the Connection to write to

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

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

write

GrizzlyFuture<WriteResult<WritableMessage,L>> write(Connection<L> connection,
                                                    L dstAddress,
                                                    WritableMessage message)

Method writes the WritableMessage to the specific address.

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

Returns:

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

write

void write(Connection<L> connection,
           L dstAddress,
           WritableMessage message,
           CompletionHandler<WriteResult<WritableMessage,L>> completionHandler)

Method writes the WritableMessage to the specific address.

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

write

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

Deprecated. push back logic is deprecated

Method writes the WritableMessage to the specific address.

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

void write(Connection<L> connection,
           L dstAddress,
           WritableMessage message,
           CompletionHandler<WriteResult<WritableMessage,L>> completionHandler,
           MessageCloner<WritableMessage> messageCloner)

Method writes the WritableMessage to the specific address.

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

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

canWrite

boolean canWrite(Connection<L> connection)

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

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

Since:

2.3

notifyWritePossible

void notifyWritePossible(Connection<L> connection,
                         WriteHandler writeHandler)

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.

Parameters:

connection - Connection

writeHandler - WriteHandler to be notified.

Since:

2.3