Package org.apache.sshd.common
Interface Closeable
- All Superinterfaces:
AutoCloseable
,Channel
,Closeable
- All Known Subinterfaces:
AgentForwardSupport
,Channel
,ClientChannel
,ClientSession
,CloseableExecutorService
,ConnectionService
,Forwarder
,IoAcceptor
,IoConnector
,IoInputStream
,IoOutputStream
,IoService
,IoServiceFactory
,IoSession
,ServerChannel
,ServerSession
,Service
,Session
,SessionContext
,X11ForwardSupport
- All Known Implementing Classes:
AbstractChannel
,AbstractChannel.GracefulChannelCloseable
,AbstractClientChannel
,AbstractClientSession
,AbstractCloseable
,AbstractConnectionService
,AbstractFactoryManager
,AbstractInnerCloseable
,AbstractIoServiceFactory
,AbstractKexFactoryManager
,AbstractServerChannel
,AbstractServerSession
,AbstractSession
,AgentForwardedChannel
,BufferedIoOutputStream
,ChannelAgentForwarding
,ChannelAsyncInputStream
,ChannelAsyncOutputStream
,ChannelDirectTcpip
,ChannelExec
,ChannelForwardedX11
,ChannelSession
,ChannelSession
,ChannelSession.CommandCloseable
,ChannelShell
,ChannelSubsystem
,ClientConnectionService
,ClientSessionImpl
,ClientUserAuthService
,DefaultAgentForwardSupport
,DefaultForwarder
,DefaultSftpClient.SftpChannelSubsystem
,DefaultX11ForwardSupport
,FuturesCloseable
,IoBaseCloseable
,Nio2Acceptor
,Nio2Connector
,Nio2Service
,Nio2ServiceFactory
,Nio2Session
,NoCloseExecutor
,ParallelCloseable
,PtyCapableChannelSession
,SequentialCloseable
,ServerConnectionService
,ServerSessionImpl
,ServerUserAuthService
,SessionHelper
,SimpleCloseable
,SimpleIoOutputStream
,SocksProxy
,SshClient
,SshServer
,SshThreadPoolExecutor
,SshThreadPoolExecutor.DelegateCloseable
,TcpipClientChannel
,TcpipServerChannel
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)-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCloseFutureListener
(SshFutureListener<CloseFuture> listener) Pre-register a listener to be informed when resource is closed.default void
close()
close
(boolean immediately) Close this resource asynchronously and return a future.static void
static Duration
getMaxCloseWaitTime
(PropertyResolver resolver) boolean
isClosed()
Returnstrue
if this object has been closed.boolean
Returnstrue
if theclose(boolean)
method has been called.default boolean
isOpen()
void
Remove a pre-registered close event listener
-
Method Details
-
close
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
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 notificationSshFutureListener
- nevernull
-
removeCloseFutureListener
Remove a pre-registered close event listener- Parameters:
listener
- The registerSshFutureListener
- nevernull
. Ignored if not registered or resource already closed
-
isClosed
boolean isClosed()Returnstrue
if this object has been closed.- Returns:
true
if closing
-
isClosing
boolean isClosing()Returnstrue
if theclose(boolean)
method has been called. Note that this method will returntrue
even if thisisClosed()
returnstrue
.- Returns:
true
if closing
-
isOpen
default boolean isOpen() -
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceChannel
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
getMaxCloseWaitTime
-
close
- Throws:
IOException
-