org.apache.flink.runtime.io.async

类 AbstractAsyncCallableWithResources<V>

java.lang.Object

org.apache.flink.runtime.io.async.AbstractAsyncCallableWithResources<V>

类型参数:

V - return type of the asynchronous call.

所有已实现的接口:

Callable<V>, AsyncDoneCallback, AsyncStoppable, StoppableCallbackCallable<V>

public abstract class AbstractAsyncCallableWithResources<V>
extends Object
implements StoppableCallbackCallable<V>

This abstract class encapsulates the lifecycle and execution strategy for asynchronous operations that use resources.

构造器概要

构造器

构造器和说明
AbstractAsyncCallableWithResources()

方法概要

限定符和类型	方法和说明
protected abstract void	acquireResources() Open the IO Handle (e.g. a stream) on which the operation will be performed.
V	call() This method implements the strategy for the actual IO operation: 1) Acquire resources asynchronously and atomically w.r.t stopping. 2) Performs the operation 3) Releases resources.
void	done(boolean canceled) Optional callback that subclasses can implement.
Exception	getStopException() Returns a potential exception that might have been observed while stopping the operation.
boolean	isCalled() True once the async method was called.
boolean	isStopped() Check if the IO operation is stopped
protected abstract V	performOperation() Implements the actual operation.
protected abstract void	releaseResources() Releases resources acquired by this object.
void	stop() Stops the I/O operation by closing the I/O handle.
protected abstract void	stopOperation() This method implements how the operation is stopped.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

AbstractAsyncCallableWithResources

public AbstractAsyncCallableWithResources()

方法详细资料

call

public final V call()
             throws Exception

This method implements the strategy for the actual IO operation:

1) Acquire resources asynchronously and atomically w.r.t stopping. 2) Performs the operation 3) Releases resources.

指定者:

call 在接口中 Callable<V>

返回:

Result of the IO operation, e.g. a deserialized object.

抛出:

Exception - exception that happened during the call.

acquireResources

protected abstract void acquireResources()
                                  throws Exception

Open the IO Handle (e.g. a stream) on which the operation will be performed.

抛出:

Exception - if there was a problem in acquiring.

performOperation

protected abstract V performOperation()
                               throws Exception

Implements the actual operation.

返回:

Result of the operation

抛出:

Exception - if there was a problem in executing the operation.

releaseResources

protected abstract void releaseResources()
                                  throws Exception

Releases resources acquired by this object.

抛出:

Exception - if there was a problem in releasing resources.

stopOperation

protected abstract void stopOperation()
                               throws Exception

This method implements how the operation is stopped. Usually this involves interrupting or closing some resources like streams to return from blocking calls.

抛出:

Exception - on problems during the stopping.

stop

public final void stop()

Stops the I/O operation by closing the I/O handle. If an exception is thrown on close, it can be accessed via #getStopException().

指定者:

stop 在接口中 AsyncStoppable

done

public void done(boolean canceled)

Optional callback that subclasses can implement. This is called when the callable method completed, e.g. because it finished or was stopped.

指定者:

done 在接口中 AsyncDoneCallback

参数:

canceled - true if the callback is done, but was canceled

isCalled

public boolean isCalled()

True once the async method was called.

isStopped

public boolean isStopped()

Check if the IO operation is stopped

指定者:

isStopped 在接口中 AsyncStoppable

返回:

true if stop() was called

getStopException

public Exception getStopException()

Returns a potential exception that might have been observed while stopping the operation.

指定者:

getStopException 在接口中 AsyncStoppable

返回:

Exception that can happen during stop