OpenJDK 27 · sun.nio.ch.PendingFuture · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final A	attachment
private final AsynchronousChannel	channel
private volatile Object	context
private volatile Throwable	exc
private final CompletionHandler<V, ? super A>	handler
private volatile boolean	haveResult
private CountDownLatch	latch
private volatile V	result
private Future<?>	timeoutTask

Constructor Summary

Access	Constructor and Description
pack-priv	PendingFuture(AsynchronousChannel channel, CompletionHandler<V, ? super A> handler, A attachment, Object context)
pack-priv	PendingFuture(AsynchronousChannel channel, CompletionHandler<V, ? super A> handler, A attachment)
pack-priv	PendingFuture(AsynchronousChannel channel)
pack-priv	PendingFuture(AsynchronousChannel channel, Object context)

Method Summary

Modifier and Type	Method and Description
pack-priv A	attachment()
public boolean	cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
pack-priv AsynchronousChannel	channel()
pack-priv Throwable	exception()
public V	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public V	get(long timeout, TimeUnit unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
pack-priv Object	getContext()
pack-priv CompletionHandler<V, ? super A>	handler()
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.
private boolean	prepareForWait()
pack-priv void	setContext(Object context)
pack-priv void	setFailure(Throwable x) Sets the result, or a no-op if the result or exception is already set.
pack-priv void	setResult(V res) Sets the result, or a no-op if the result or exception is already set.
pack-priv void	setResult(V res, Throwable x) Sets the result
pack-priv void	setTimeoutTask(Future<?> task)
pack-priv V	value()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attachment	back to summary
private final A attachment

channel	back to summary
private final AsynchronousChannel channel

context	back to summary
private volatile Object context

exc	back to summary
private volatile Throwable exc

handler	back to summary
private final CompletionHandler<V, ? super A> handler

haveResult	back to summary
private volatile boolean haveResult

latch	back to summary
private CountDownLatch latch

result	back to summary
private volatile V result

timeoutTask	back to summary
private Future<?> timeoutTask

Constructor Detail

PendingFuture	back to summary
pack-priv PendingFuture(AsynchronousChannel channel, CompletionHandler<V, ? super A> handler, A attachment, Object context)

PendingFuture	back to summary
pack-priv PendingFuture(AsynchronousChannel channel, CompletionHandler<V, ? super A> handler, A attachment)

PendingFuture	back to summary
pack-priv PendingFuture(AsynchronousChannel channel)

PendingFuture	back to summary
pack-priv PendingFuture(AsynchronousChannel channel, Object context)

Method Detail

attachment	back to summary
pack-priv A attachment()

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Annotations

@Override

channel	back to summary
pack-priv AsynchronousChannel channel()

exception	back to summary
pack-priv Throwable exception()

get	back to summary
public V get() throws ExecutionException, InterruptedException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Annotations @Override Exceptions ExecutionException: if the computation threw an exception InterruptedException: if the current thread was interrupted while waiting

get

back to summary

public V get() throws ExecutionException, InterruptedException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Annotations

@Override

Exceptions

ExecutionException:: if the computation threw an exception
InterruptedException:: if the current thread was interrupted while waiting

get	back to summary
public V get(long timeout, TimeUnit unit) throws ExecutionException, InterruptedException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Annotations @Override Exceptions ExecutionException: if the computation threw an exception InterruptedException: if the current thread was interrupted while waiting TimeoutException: if the wait timed out

get

back to summary

public V get(long timeout, TimeUnit unit) throws ExecutionException, InterruptedException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Annotations

@Override

Exceptions

ExecutionException:: if the computation threw an exception
InterruptedException:: if the current thread was interrupted while waiting
TimeoutException:: if the wait timed out

getContext	back to summary
pack-priv Object getContext()

handler	back to summary
pack-priv CompletionHandler<V, ? super A> handler()

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Annotations

@Override

prepareForWait	back to summary
private boolean prepareForWait()

setContext	back to summary
pack-priv void setContext(Object context)

setFailure	back to summary
pack-priv void setFailure(Throwable x) Sets the result, or a no-op if the result or exception is already set.

setResult	back to summary
pack-priv void setResult(V res) Sets the result, or a no-op if the result or exception is already set.

setResult	back to summary
pack-priv void setResult(V res, Throwable x) Sets the result

setTimeoutTask	back to summary
pack-priv void setTimeoutTask(Future<?> task)

value	back to summary
pack-priv V value()

pack-priv final Class PendingFuture<V, A>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail