org.apache.sshd.common

Interface Closeable

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Subinterfaces:

CloseableExecutorService, IoAcceptor, IoConnector, IoInputStream, IoOutputStream, IoService, IoServiceFactory, IoSession, SessionContext

All Known Implementing Classes:

NoCloseExecutor, SshThreadPoolExecutor

public interface Closeable
extends Channel

A Closeable is a resource that can be closed. The close method is invoked to release resources that the object is holding. The user can pre-register listeners to be notified when resource close is completed (successfully or otherwise)

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_WAIT_TIMEOUT Timeout (milliseconds) for waiting on a CloseFuture to successfully complete its action.
static long	DEFAULT_CLOSE_WAIT_TIMEOUT Default value for CLOSE_WAIT_TIMEOUT if none specified

Method Summary

Modifier and Type	Method and Description
void	addCloseFutureListener(SshFutureListener<CloseFuture> listener) Pre-register a listener to be informed when resource is closed.
default void	close()
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
static void	close(Closeable closeable)
static long	getMaxCloseWaitTime(PropertyResolver resolver)
boolean	isClosed() Returns true if this object has been closed.
boolean	isClosing() Returns true if the close(boolean) method has been called.
default boolean	isOpen()
void	removeCloseFutureListener(SshFutureListener<CloseFuture> listener) Remove a pre-registered close event listener

Field Detail

CLOSE_WAIT_TIMEOUT

static final String CLOSE_WAIT_TIMEOUT

Timeout (milliseconds) for waiting on a CloseFuture to successfully complete its action.

See Also:

DEFAULT_CLOSE_WAIT_TIMEOUT, Constant Field Values

DEFAULT_CLOSE_WAIT_TIMEOUT

static final long DEFAULT_CLOSE_WAIT_TIMEOUT

Default value for CLOSE_WAIT_TIMEOUT if none specified

Method Detail

close

CloseFuture close(boolean immediately)

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a CloseFuture representing the close request

addCloseFutureListener

void addCloseFutureListener(SshFutureListener<CloseFuture> listener)

Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification

Parameters:

listener - The notification SshFutureListener - never null

removeCloseFutureListener

void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)

Remove a pre-registered close event listener

Parameters:

listener - The register SshFutureListener - never null. Ignored if not registered or resource already closed

isClosed

boolean isClosed()

Returns true if this object has been closed.

Returns:

true if closing

isClosing

boolean isClosing()

Returns true if the close(boolean) method has been called. Note that this method will return true even if this isClosed() returns true.

Returns:

true if closing

isOpen

default boolean isOpen()

Specified by:

isOpen in interface Channel

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException

getMaxCloseWaitTime

static long getMaxCloseWaitTime(PropertyResolver resolver)

close

static void close(Closeable closeable)
           throws IOException

Throws:

IOException