DefaultCloseFuture

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<CloseFuture>

org.apache.sshd.common.future.DefaultSshFuture<CloseFuture>

org.apache.sshd.common.future.DefaultCloseFuture

All Implemented Interfaces:: CloseFuture, SshFuture<CloseFuture>, WaitableFuture

public class DefaultCloseFuture extends DefaultSshFuture<CloseFuture> implements CloseFuture

A default implementation of CloseFuture.

Field Summary

Fields inherited from class AbstractLoggingBean
log
Constructor Summary

Constructors

Constructor

Description

DefaultCloseFuture(Object id, Object lock)

Create a new instance
Method Summary

Modifier and Type

Method

Description

boolean

isClosed()

void

setClosed()

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

Methods inherited from class DefaultSshFuture
addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class AbstractSshFuture
asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SshFuture
addListener, removeListener

Methods inherited from interface WaitableFuture
await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Constructor Details
- DefaultCloseFuture
  
  public DefaultCloseFuture(Object id, Object lock)
  
  Create a new instance
  
  Parameters:
  
  id - Some identifier useful as toString() value
  
  lock - A synchronization object for locking access - if null then synchronization occurs on this instance
Method Details
- isClosed
  
  public boolean isClosed()
  
  Specified by:
  
  isClosed in interface CloseFuture
  
  Returns:
  
  true if the close request is finished and the target is closed.
- setClosed
  
  public void setClosed()
  
  Description copied from interface: CloseFuture
  
  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.
  
  Specified by:
  
  setClosed in interface CloseFuture