org.apache.sshd.common.future

Interface Cancellable

All Superinterfaces:

HasException, WithException

All Known Subinterfaces:

IoConnectFuture

All Known Implementing Classes:

DefaultCancellableSshFuture, DefaultIoConnectFuture

public interface Cancellable
extends WithException

Some operation that can be cancelled.

Classes implementing this interface that support state listeners are expected to notify the listeners when cancel() changes the state of the operation.

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
CancelFuture	cancel() Attempts to cancel the operation.
CancelFuture	getCancellation() Retrieves the CancelFuture, if cancel() had been called.
boolean	isCanceled() Tells whether this operation was canceled.

Methods inherited from interface org.apache.sshd.common.future.WithException

setException

Methods inherited from interface org.apache.sshd.common.future.HasException

getException

Method Detail

cancel

CancelFuture cancel()

Attempts to cancel the operation.

Returns:

A CancelFuture that can be used to wait for the cancellation to have been effected, or null if the future cannot be canceled or is already completed.

isCanceled

boolean isCanceled()

Tells whether this operation was canceled.

Returns:

true if the operation was cancelled, false otherwise.

getCancellation

CancelFuture getCancellation()

Retrieves the CancelFuture, if cancel() had been called.

Returns:

The CancelFuture if the Cancellable has already been canceled, or null otherwise