org.apache.sshd.common

Interface Closeable

All Known Subinterfaces:

Channel, ClientSession, ConnectionService, IoAcceptor, IoConnector, IoInputStream, IoOutputStream, IoService, IoServiceFactory, IoSession, Service, Session, TcpipForwarder

All Known Implementing Classes:

AbstractChannel, AbstractChannel.GracefulChannelCloseable, AbstractClientChannel, AbstractConnectionService, AbstractFactoryManager, AbstractServerChannel, AbstractSession, AgentForwardedChannel, AgentForwardedChannel, AgentForwardSupport, BufferedIoOutputStream, ChannelAgentForwarding, ChannelAgentForwarding, ChannelAsyncInputStream, ChannelAsyncOutputStream, ChannelDirectTcpip, ChannelExec, ChannelSession, ChannelSession, ChannelSession.CommandCloseable, ChannelShell, ChannelSubsystem, ClientConnectionService, ClientSessionImpl, ClientUserAuthService, ClientUserAuthServiceNew, ClientUserAuthServiceOld, CloseableUtils.AbstractCloseable, CloseableUtils.AbstractInnerCloseable, DefaultTcpipForwarder, MinaAcceptor, MinaConnector, MinaService, MinaServiceFactory, MinaSession, Nio2Acceptor, Nio2Connector, Nio2Service, Nio2ServiceFactory, Nio2Session, PtyCapableChannelSession, ServerConnectionService, ServerSession, ServerUserAuthService, SshClient, SshServer, TcpipClientChannel, TcpipServerChannel, X11ForwardSupport, X11ForwardSupport.ChannelForwardedX11

public interface Closeable

A Closeable is a resource that can be closed. The close method is invoked to release resources that the object is holding.

Author:

Apache MINA SSHD Project

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
boolean	isClosed() Returns true< if this object has been closed.
boolean	isClosing() Returns true if the close(boolean) method has been called.

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 future

isClosed

boolean isClosed()

Returns true< if this object has been closed.

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.