Top Description Constructors Methods
org.apache.sshd.common.future

public Class DefaultCloseFuture

extends DefaultSshFuture<CloseFuture>
implements CloseFuture
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.future.CloseFuture, org.apache.sshd.common.future.SshFuture, org.apache.sshd.common.future.WaitableFuture
A default implementation of CloseFuture.
Author
Apache MINA SSHD Project

Constructor Summary

AccessConstructor and Description
public
DefaultCloseFuture(Object
Some identifier useful as toString() value
id, Object
A synchronization object for locking access - if null then synchronization occurs on this instance
lock)

Create a new instance

Method Summary

Modifier and TypeMethod and Description
public boolean
isClosed()

Implements org.apache.sshd.common.future.CloseFuture.isClosed.

public void
setClosed()

Implements org.apache.sshd.common.future.CloseFuture.setClosed.

Marks this future as closed and notifies all threads waiting for this future.

Inherited from org.apache.sshd.common.future.DefaultSshFuture:
addListenerawait0createCancellationgetNumRegisteredListenersgetValueisDonenotifyListenersonValueSetremoveListenersetValuetoString

Constructor Detail

DefaultCloseFutureback to summary
public DefaultCloseFuture(Object id, Object lock)

Create a new instance

Parameters
id:Object

Some identifier useful as toString() value

lock:Object

A synchronization object for locking access - if null then synchronization occurs on this instance

Method Detail

isClosedback to summary
public boolean isClosed()

Implements org.apache.sshd.common.future.CloseFuture.isClosed.

Returns:boolean

Doc from org.apache.sshd.common.future.CloseFuture.isClosed.

true if the close request is finished and the target is closed.

Annotations
@Override
setClosedback to summary
public void setClosed()

Implements org.apache.sshd.common.future.CloseFuture.setClosed.

Doc from org.apache.sshd.common.future.CloseFuture.setClosed.

Marks this future as closed and notifies all threads waiting for this future. This method is invoked by SSHD internally. Please do not call this method directly.

Annotations
@Override