Closeable

All Superinterfaces:

java.lang.AutoCloseable, java.nio.channels.Channel, java.io.Closeable

All Known Subinterfaces:

AgentForwardSupport, Channel, ClientChannel, ClientSession, CloseableExecutorService, ConnectionService, ForwardingFilter, IoAcceptor, IoConnector, IoInputStream, IoOutputStream, IoService, IoServiceFactory, IoSession, ServerChannel, ServerSession, Service, Session, X11ForwardSupport

All Known Implementing Classes:

AbstractClientChannel, AbstractClientSession, AbstractConnectionService, AbstractIoServiceFactory, AbstractServerChannel, AbstractServerSession, AbstractSession, AgentForwardedChannel, BufferedIoOutputStream, ChannelAgentForwarding, ChannelAsyncInputStream, ChannelAsyncOutputStream, ChannelDirectTcpip, ChannelExec, ChannelForwardedX11, ChannelSession, ChannelSession, ChannelShell, ChannelSubsystem, ClientConnectionService, ClientSessionImpl, ClientUserAuthService, DefaultAgentForwardSupport, DefaultForwardingFilter, DefaultX11ForwardSupport, Nio2Acceptor, Nio2Connector, Nio2Service, Nio2ServiceFactory, Nio2Session, NoCloseExecutor, PtyCapableChannelSession, ServerConnectionService, ServerSessionImpl, ServerUserAuthService, SessionHelper, SshThreadPoolExecutor, TcpipClientChannel, TcpipServerChannel
```
public interface Closeable
extends java.nio.channels.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)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
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 java.lang.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 java.nio.channels.Channel
  - close
```
default void close()
            throws java.io.IOException
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.nio.channels.Channel
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException
  - getMaxCloseWaitTime
```
static long getMaxCloseWaitTime(PropertyResolver resolver)
```
  - close
```
static void close(Closeable closeable)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Interface Closeable

Field Summary

Method Summary

Field Detail

CLOSE_WAIT_TIMEOUT

DEFAULT_CLOSE_WAIT_TIMEOUT

Method Detail

close

addCloseFutureListener

removeCloseFutureListener

isClosed

isClosing

isOpen

close

getMaxCloseWaitTime

close