org.apache.sshd.common.future.WaitableFuture Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.sshd.common.future;
import java.io.IOException;
import java.time.Duration;
import java.util.concurrent.TimeUnit;
/**
* Represents an asynchronous operation which one can wait for its completion. Note: the only thing guaranteed is
* that if {@code true} is returned from one of the {@code awaitXXX} methods then the operation has completed. However,
* the caller has to determine whether it was a successful or failed completion.
*
* @author Apache MINA SSHD Project
*/
public interface WaitableFuture {
/**
* @return Some identifier useful as {@code toString()} value
*/
Object getId();
/**
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to complete. The attached listeners will be
* notified when the operation is completed.
*
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await() throws IOException {
return await(new CancelOption[0]);
}
/**
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to complete. The attached listeners will be
* notified when the operation is completed.
*
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await(CancelOption... options) throws IOException {
return await(Long.MAX_VALUE, options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await(long timeout, TimeUnit unit) throws IOException {
return await(timeout, unit, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await(long timeout, TimeUnit unit, CancelOption... options) throws IOException {
return await(unit.toMillis(timeout), options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeout The maximum duration to wait, null to wait forever
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await(Duration timeout) throws IOException {
return await(timeout, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeout The maximum duration to wait, null to wait forever
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if the
* future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
* @see #await(long, CancelOption[])
*/
default boolean await(Duration timeout, CancelOption... options) throws IOException {
return timeout != null ? await(timeout.toMillis(), options) : await(options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeoutMillis Wait time in milliseconds
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
*/
default boolean await(long timeoutMillis) throws IOException {
return await(timeoutMillis, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeoutMillis Wait time in milliseconds
* @param options Optional {@link CancelOption}s defining the behavior on time-out or interrupt; ignored if
* the future is not {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @throws IOException if failed - specifically {@link java.io.InterruptedIOException} if waiting was interrupted
*/
boolean await(long timeoutMillis, CancelOption... options) throws IOException;
/**
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to complete uninterruptibly. The attached
* listeners will be notified when the operation is completed.
*
* @return {@code true} if the operation is completed.
* @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly() {
return awaitUninterruptibly(new CancelOption[0]);
}
/**
* Wait {@link Long#MAX_VALUE} msec. for the asynchronous operation to complete uninterruptibly. The attached
* listeners will be notified when the operation is completed.
*
* @param options Optional {@link CancelOption}s defining the behavior on time-out; ignored if the future is not
* {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly(CancelOption... options) {
return awaitUninterruptibly(Long.MAX_VALUE, options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
* @return {@code true} if the operation is completed.
* @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly(long timeout, TimeUnit unit) {
return awaitUninterruptibly(timeout, unit, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeout The number of time units to wait
* @param unit The {@link TimeUnit} for waiting
* @param options Optional {@link CancelOption}s defining the behavior on time-out; ignored if the future is not
* {@link Cancellable}.
* @return {@code true} if the operation is completed.
* @see #awaitUninterruptibly(long, CancelOption[])
*/
default boolean awaitUninterruptibly(long timeout, TimeUnit unit, CancelOption... options) {
return awaitUninterruptibly(unit.toMillis(timeout), options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeoutMillis Wait time, null to wait forever
* @return {@code true} if the operation is finished.
*/
default boolean awaitUninterruptibly(Duration timeoutMillis) {
return awaitUninterruptibly(timeoutMillis, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeoutMillis Wait time, null to wait forever
* @param options Optional {@link CancelOption}s defining the behavior on time-out; ignored if the future is
* not {@link Cancellable}.
* @return {@code true} if the operation is finished.
*/
default boolean awaitUninterruptibly(Duration timeoutMillis, CancelOption... options) {
return timeoutMillis != null ? awaitUninterruptibly(timeoutMillis.toMillis(), options) : awaitUninterruptibly(options);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeoutMillis Wait time in milliseconds
* @return {@code true} if the operation is finished.
*/
default boolean awaitUninterruptibly(long timeoutMillis) {
return awaitUninterruptibly(timeoutMillis, new CancelOption[0]);
}
/**
* Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
*
* @param timeoutMillis Wait time in milliseconds
* @param options Optional {@link CancelOption}s defining the behavior on time-out; ignored if the future is
* not {@link Cancellable}.
* @return {@code true} if the operation is finished.
*/
boolean awaitUninterruptibly(long timeoutMillis, CancelOption... options);
/**
* @return {@code true} if the asynchronous operation is completed. Note: it is up to the caller to
* determine whether it was a successful or failed completion.
*/
boolean isDone();
}