Apache Mina SSHD 2.15.0 · org.apache.sshd.common.Closeable

Method Summary

Modifier and Type	Method and Description
public void	addCloseFutureListener(SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null` listener) Pre-register a listener to be informed when resource is closed.
public CloseFuture	Returns: a `CloseFuture` representing the close request close(boolean `true` if the resource should be shut down abruptly, `false` for a graceful close immediately) Close this resource asynchronously and return a future.
public default void	close() Implements java.nio.channels.Channel.close. Closes this channel.
public static void	close(Closeable closeable)
public static Duration	getMaxCloseWaitTime(PropertyResolver resolver)
public boolean	Returns: `true` if closing isClosed() Returns `true` if this object has been closed.
public boolean	Returns: `true` if closing isClosing() Returns `true` if the `close(boolean)` method has been called.
public default boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public void	removeCloseFutureListener(SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed listener) Remove a pre-registered close event listener

Method Detail

addCloseFutureListener back to summary

addCloseFutureListener	back to summary
public 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:SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null`

public 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:SshFutureListener<CloseFuture>: The notification SshFutureListener - never null

close back to summary

close	back to summary
public 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:boolean `true` if the resource should be shut down abruptly, `false` for a graceful close Returns:CloseFuture a `CloseFuture` representing the close request

public 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:boolean: true if the resource should be shut down abruptly, false for a graceful close

Returns:CloseFuture

a CloseFuture representing the close request

close back to summary

close	back to summary
public default void close() throws IOException Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public default void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

close	back to summary
public static void close(Closeable closeable) throws IOException

getMaxCloseWaitTime	back to summary
public static Duration getMaxCloseWaitTime(PropertyResolver resolver)

isClosed back to summary

isClosed	back to summary
public boolean isClosed() Returns `true` if this object has been closed. Returns:boolean `true` if closing

public boolean isClosed()

Returns true if this object has been closed.

Returns:boolean: true if closing

isClosing back to summary

isClosing	back to summary
public 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:boolean `true` if closing

public 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:boolean: true if closing

isOpen back to summary

isOpen	back to summary
public default boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public default boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

removeCloseFutureListener back to summary

removeCloseFutureListener	back to summary
public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener) Remove a pre-registered close event listener Parameters listener:SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed

public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)

Remove a pre-registered close event listener

Parameters

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

public Interface Closeable

Method Summary

Method Detail