public class CollectSinkOperatorCoordinator extends Object implements OperatorCoordinator, CoordinationRequestHandler
OperatorCoordinator
for CollectSinkFunction
.
This coordinator only forwards requests and responses from clients and sinks and it does not store any results in itself.
Modifier and Type | Class and Description |
---|---|
static class |
CollectSinkOperatorCoordinator.Provider
Provider for
CollectSinkOperatorCoordinator . |
OperatorCoordinator.Context
NO_CHECKPOINT
Constructor and Description |
---|
CollectSinkOperatorCoordinator(int socketTimeout) |
Modifier and Type | Method and Description |
---|---|
void |
checkpointCoordinator(long checkpointId,
CompletableFuture<byte[]> result)
Takes a checkpoint of the coordinator.
|
void |
close()
This method is called when the coordinator is disposed.
|
CompletableFuture<CoordinationResponse> |
handleCoordinationRequest(CoordinationRequest request)
Called when receiving a request from the client.
|
void |
handleEventFromOperator(int subtask,
OperatorEvent event)
Hands an OperatorEvent from a task (on the Task Manager) to this coordinator.
|
void |
notifyCheckpointComplete(long checkpointId)
We override the method here to remove the checked exception.
|
void |
resetToCheckpoint(long checkpointId,
byte[] checkpointData)
Resets the coordinator to the given checkpoint.
|
void |
start()
Starts the coordinator.
|
void |
subtaskFailed(int subtask,
Throwable reason)
Called when one of the subtasks of the task running the coordinated operator goes through a
failover (failure / recovery cycle).
|
void |
subtaskReset(int subtask,
long checkpointId)
Called if a task is recovered as part of a partial failover, meaning a failover
handled by the scheduler's failover strategy (by default recovering a pipelined region).
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
notifyCheckpointAborted
public CollectSinkOperatorCoordinator(int socketTimeout)
public void start() throws Exception
OperatorCoordinator
start
in interface OperatorCoordinator
Exception
- Any exception thrown from this method causes a full job failure.public void close() throws Exception
OperatorCoordinator
close
in interface AutoCloseable
close
in interface OperatorCoordinator
Exception
public void handleEventFromOperator(int subtask, OperatorEvent event) throws Exception
OperatorCoordinator
handleEventFromOperator
in interface OperatorCoordinator
Exception
- Any exception thrown by this method results in a full job failure and
recovery.public CompletableFuture<CoordinationResponse> handleCoordinationRequest(CoordinationRequest request)
CoordinationRequestHandler
handleCoordinationRequest
in interface CoordinationRequestHandler
request
- the request receivedpublic void subtaskFailed(int subtask, @Nullable Throwable reason)
OperatorCoordinator
This method is called every time there is a failover of a subtasks, regardless of whether there it is a partial failover or a global failover.
subtaskFailed
in interface OperatorCoordinator
public void subtaskReset(int subtask, long checkpointId)
OperatorCoordinator
In contrast to this method, the OperatorCoordinator.resetToCheckpoint(long, byte[])
method is called
in the case of a global failover, which is the case when the coordinator (JobManager) is
recovered.
subtaskReset
in interface OperatorCoordinator
public void checkpointCoordinator(long checkpointId, CompletableFuture<byte[]> result) throws Exception
OperatorCoordinator
To confirm the checkpoint and store state in it, the given CompletableFuture
must
be completed with the state. To abort or dis-confirm the checkpoint, the given CompletableFuture
must be completed exceptionally. In any case, the given CompletableFuture
must be completed in some way, otherwise the checkpoint will not progress.
The semantics are defined as follows:
checkpointCoordinator
in interface OperatorCoordinator
Exception
public void notifyCheckpointComplete(long checkpointId)
OperatorCoordinator
CheckpointListener.notifyCheckpointComplete(long)
for more detail semantic of the
method.notifyCheckpointComplete
in interface OperatorCoordinator
notifyCheckpointComplete
in interface CheckpointListener
checkpointId
- The ID of the checkpoint that has been completed.public void resetToCheckpoint(long checkpointId, @Nullable byte[] checkpointData) throws Exception
OperatorCoordinator
This method is called in the case of a global failover of the system, which means a
failover of the coordinator (JobManager). This method is not invoked on a partial
failover; partial failovers call the OperatorCoordinator.subtaskReset(int, long)
method for the
involved subtasks.
This method is expected to behave synchronously with respect to other method calls and
calls to Context
methods. For example, Events being sent by the Coordinator after
this method returns are assumed to take place after the checkpoint that was restored.
This method is called with a null state argument in the following situations:
Restoring to a checkpoint is a way of confirming that the checkpoint is complete. It is safe to commit side-effects that are predicated on checkpoint completion after this call.
Even if no call to OperatorCoordinator.notifyCheckpointComplete(long)
happened, the checkpoint can
still be complete (for example when a system failure happened directly after committing the
checkpoint, before calling the OperatorCoordinator.notifyCheckpointComplete(long)
method).
resetToCheckpoint
in interface OperatorCoordinator
Exception
Copyright © 2014–2021 The Apache Software Foundation. All rights reserved.