org.glassfish.grizzly

Interface OutputSink

All Known Subinterfaces:

BinaryNIOOutputSink, Connection<L>, Writeable<L>

All Known Implementing Classes:

NIOConnection, NIOOutputStream, NIOWriter, TCPNIOConnection, TCPNIOServerConnection, UDPNIOConnection, UDPNIOServerConnection

public interface OutputSink

This interface defines methods to allow an OutputStream or Writer to allow the developer to check with the runtime whether or not it's possible to write a certain amount of data, or if it's not possible, to be notified when it is.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canWrite()
boolean	canWrite(int length) Deprecated. the length parameter will be ignored. Pls. use canWrite().
void	notifyCanWrite(WriteHandler handler) Instructs the OutputSink to invoke the provided WriteHandler when it is possible to write more bytes (or characters).
void	notifyCanWrite(WriteHandler handler, int length) Deprecated. the length parameter will be ignored. Pls. use notifyCanWrite(org.glassfish.grizzly.WriteHandler).

Method Detail

notifyCanWrite

void notifyCanWrite(WriteHandler handler)

Instructs the OutputSink to invoke the provided WriteHandler when it is possible to write more bytes (or characters). Note that once the WriteHandler has been notified, it will not be considered for notification again at a later point in time.

Parameters:

handler - the WriteHandler that should be notified when it's possible to write more data.

Throws:

IllegalStateException - if this method is invoked and a handler from a previous invocation is still present (due to not having yet been notified).

Since:

2.3

notifyCanWrite

@Deprecated
void notifyCanWrite(WriteHandler handler,
                             int length)

Deprecated. the length parameter will be ignored. Pls. use notifyCanWrite(org.glassfish.grizzly.WriteHandler).

Instructs the OutputSink to invoke the provided WriteHandler when it is possible to write length bytes (or characters). Note that once the WriteHandler has been notified, it will not be considered for notification again at a later point in time.

Parameters:

handler - the WriteHandler that should be notified when it's possible to write length bytes.

length - the number of bytes or characters that require writing.

Throws:

IllegalStateException - if this method is invoked and a handler from a previous invocation is still present (due to not having yet been notified).

canWrite

boolean canWrite()

Returns:

true if a write to this OutputSink will succeed, otherwise returns false.

Since:

2.3

canWrite

@Deprecated
boolean canWrite(int length)

Deprecated. the length parameter will be ignored. Pls. use canWrite().

Parameters:

length - specifies the number of bytes (or characters) that require writing

Returns:

true if a write to this OutputSink will succeed, otherwise returns false.