org.glassfish.grizzly

Interface Closeable

All Known Subinterfaces:

Connection<L>

All Known Implementing Classes:

NIOConnection, TCPNIOConnection, TCPNIOServerConnection, UDPNIOConnection, UDPNIOServerConnection

public interface Closeable

General asynchronous closable interface. Closeable interface contains two sets of methods: close* and terminate*, so interface implementations can provide graceful and abrupt releasing of resources.

Author:

Alexey Stashok

Method Summary

Methods

Modifier and Type	Method and Description
void	addCloseListener(CloseListener closeListener) Add the CloseListener, which will be notified once the stream will be closed.
GrizzlyFuture<Closeable>	close() Gracefully (if supported by the implementation) closes this stream and releases any system resources associated with it.
void	close(CompletionHandler<Closeable> completionHandler) Deprecated. please use close() with the following GrizzlyFuture.addCompletionHandler(org.glassfish.grizzly.CompletionHandler) call
void	closeSilently() Gracefully (if supported by the implementation) closes this stream and releases any system resources associated with it.
boolean	removeCloseListener(CloseListener closeListener) Remove the CloseListener.
GrizzlyFuture<Closeable>	terminate() Closes this stream and releases any system resources associated with it.
void	terminateSilently() Closes this stream and releases any system resources associated with it.

Method Detail

terminateSilently

void terminateSilently()

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. Use this method, when no completion notification is needed.

terminate

GrizzlyFuture<Closeable> terminate()

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Returns:

Future, which could be checked in case, if close operation will be run asynchronously

closeSilently

void closeSilently()

Gracefully (if supported by the implementation) closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. Use this method, when no completion notification is needed.

close

GrizzlyFuture<Closeable> close()

Gracefully (if supported by the implementation) closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

Returns:

Future, which could be checked in case, if close operation will be run asynchronously

close

void close(CompletionHandler<Closeable> completionHandler)

Deprecated. please use close() with the following GrizzlyFuture.addCompletionHandler(org.glassfish.grizzly.CompletionHandler) call

Gracefully closes this stream and releases any system resources associated with it. This operation waits for all pending output data to be flushed before closing the stream. If the stream is already closed then invoking this method has no effect.

Parameters:

completionHandler - CompletionHandler to be called, when the stream is closed

addCloseListener

void addCloseListener(CloseListener closeListener)

Add the CloseListener, which will be notified once the stream will be closed.

Parameters:

closeListener - CloseListener.

removeCloseListener

boolean removeCloseListener(CloseListener closeListener)

Remove the CloseListener.

Parameters:

closeListener - CloseListener.

Returns:

true if the listener was successfully removed, or false otherwise.