org.apache.flink.runtime.checkpoint

Class AbstractAsyncSnapshotIOCallable<H extends StateObject>

java.lang.Object

org.apache.flink.runtime.io.async.AbstractAsyncIOCallable<H,CheckpointStreamFactory.CheckpointStateOutputStream>

org.apache.flink.runtime.checkpoint.AbstractAsyncSnapshotIOCallable<H>

All Implemented Interfaces:

Callable<H>, AsyncDoneCallback, AsyncStoppable, StoppableCallbackCallable<H>

public abstract class AbstractAsyncSnapshotIOCallable<H extends StateObject>
extends AbstractAsyncIOCallable<H,CheckpointStreamFactory.CheckpointStateOutputStream>

Abstract base class for async IO operations of snapshots against a CheckedOutputStream. This includes participating in lifecycle management through a CloseableRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	checkpointId
protected CloseableRegistry	closeStreamOnCancelRegistry
protected AtomicBoolean	open
protected CheckpointStreamFactory	streamFactory
protected long	timestamp

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncSnapshotIOCallable(long checkpointId, long timestamp, CheckpointStreamFactory streamFactory, CloseableRegistry closeStreamOnCancelRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkStreamClosedAndDoTransitionToOpen()
protected boolean	checkStreamOpenAndDoTransitionToClose()
protected StreamStateHandle	closeStreamAndGetStateHandle()
void	done(boolean canceled) Optional callback that subclasses can implement.
CheckpointStreamFactory.CheckpointStateOutputStream	openIOHandle() Open the IO Handle (e.g.

Methods inherited from class org.apache.flink.runtime.io.async.AbstractAsyncIOCallable

call, getIoHandle, getStopException, isStopped, performOperation, stop

Methods inherited from class java.lang.Object

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

Field Detail

checkpointId

protected final long checkpointId

timestamp

protected final long timestamp

streamFactory

protected final CheckpointStreamFactory streamFactory

closeStreamOnCancelRegistry

protected final CloseableRegistry closeStreamOnCancelRegistry

open

protected final AtomicBoolean open

Constructor Detail

AbstractAsyncSnapshotIOCallable

public AbstractAsyncSnapshotIOCallable(long checkpointId,
                               long timestamp,
                               CheckpointStreamFactory streamFactory,
                               CloseableRegistry closeStreamOnCancelRegistry)

Method Detail

openIOHandle

public CheckpointStreamFactory.CheckpointStateOutputStream openIOHandle()
                                                                 throws Exception

Description copied from class: AbstractAsyncIOCallable

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

Specified by:

openIOHandle in class AbstractAsyncIOCallable<H extends StateObject,CheckpointStreamFactory.CheckpointStateOutputStream>

Returns:

the opened IO handle that implements #Closeable

Throws:

Exception

done

public void done(boolean canceled)

Description copied from class: AbstractAsyncIOCallable

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

Specified by:

done in interface AsyncDoneCallback

Overrides:

done in class AbstractAsyncIOCallable<H extends StateObject,CheckpointStreamFactory.CheckpointStateOutputStream>

Parameters:

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

checkStreamClosedAndDoTransitionToOpen

protected boolean checkStreamClosedAndDoTransitionToOpen()

checkStreamOpenAndDoTransitionToClose

protected boolean checkStreamOpenAndDoTransitionToClose()

closeStreamAndGetStateHandle

protected StreamStateHandle closeStreamAndGetStateHandle()
                                                  throws IOException

Throws:

IOException