Top Fields Constructors Methods
org.apache.sshd.common.util.closeable

public Class SimpleCloseable

extends IoBaseCloseable
Class Inheritance
Known Direct Subclasses
org.apache.sshd.common.util.closeable.FuturesCloseable, org.apache.sshd.common.util.closeable.ParallelCloseable, org.apache.sshd.common.util.closeable.SequentialCloseable
Imports
java.util.concurrent.atomic.AtomicBoolean, org.apache.sshd.common.future.CloseFuture, .DefaultCloseFuture, .SshFutureListener
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected final AtomicBoolean
closing

protected final DefaultCloseFuture
future

Constructor Summary

AccessConstructor and Description
public
SimpleCloseable(Object id, Object lock)

Method Summary

Modifier and TypeMethod and Description
public void
addCloseFutureListener(SshFutureListener<CloseFuture>
The notification SshFutureListener - never null
listener)

Implements org.apache.sshd.common.Closeable.addCloseFutureListener.

Pre-register a listener to be informed when resource is closed.

public CloseFuture
close(boolean
true if the resource should be shut down abruptly, false for a graceful close
immediately)

Implements org.apache.sshd.common.Closeable.close.

Close this resource asynchronously and return a future.

protected void
doClose(boolean immediately)

public boolean
isClosed()

Implements org.apache.sshd.common.Closeable.isClosed.

Returns true if this object has been closed.

public boolean
isClosing()

Implements org.apache.sshd.common.Closeable.isClosing.

Returns true if the close(boolean) method has been called.

public void
removeCloseFutureListener(SshFutureListener<CloseFuture>
The register SshFutureListener - never null. Ignored if not registered or resource already closed
listener)

Implements org.apache.sshd.common.Closeable.removeCloseFutureListener.

Remove a pre-registered close event listener

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Field Detail

closingback to summary
protected final AtomicBoolean closing
futureback to summary
protected final DefaultCloseFuture future

Constructor Detail

SimpleCloseableback to summary
public SimpleCloseable(Object id, Object lock)

Method Detail

addCloseFutureListenerback to summary
public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.addCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.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:SshFutureListener<CloseFuture>

The notification SshFutureListener - never null

Annotations
@Override
closeback to summary
public CloseFuture close(boolean immediately)

Implements org.apache.sshd.common.Closeable.close.

Doc from org.apache.sshd.common.Closeable.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:boolean

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

Returns:CloseFuture

a CloseFuture representing the close request

Annotations
@Override
doCloseback to summary
protected void doClose(boolean immediately)
isClosedback to summary
public boolean isClosed()

Implements org.apache.sshd.common.Closeable.isClosed.

Doc from org.apache.sshd.common.Closeable.isClosed.

Returns true if this object has been closed.

Returns:boolean

true if closing

Annotations
@Override
isClosingback to summary
public boolean isClosing()

Implements org.apache.sshd.common.Closeable.isClosing.

Doc from org.apache.sshd.common.Closeable.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

Annotations
@Override
removeCloseFutureListenerback to summary
public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.removeCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.removeCloseFutureListener.

Remove a pre-registered close event listener

Parameters
listener:SshFutureListener<CloseFuture>

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

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override