org.apache.flink.runtime.dispatcher.runner

Class DefaultDispatcherRunner

java.lang.Object

org.apache.flink.runtime.dispatcher.runner.DefaultDispatcherRunner

All Implemented Interfaces:

AutoCloseable, DispatcherRunner, LeaderContender, org.apache.flink.util.AutoCloseableAsync

public final class DefaultDispatcherRunner
extends Object
implements DispatcherRunner, LeaderContender

Runner for the Dispatcher which is responsible for the leader election.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	closeAsync()
static DispatcherRunner	create(LeaderElectionService leaderElectionService, org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler, DispatcherLeaderProcessFactory dispatcherLeaderProcessFactory)
CompletableFuture<ApplicationStatus>	getShutDownFuture() Return shut down future of this runner.
void	grantLeadership(UUID leaderSessionID) Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader.
void	handleError(Exception exception) Callback method which is called by LeaderElectionService in case of an error in the service thread.
void	revokeLeadership() Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.runtime.leaderelection.LeaderContender

getDescription

Method Detail

getShutDownFuture

public CompletableFuture<ApplicationStatus> getShutDownFuture()

Description copied from interface: DispatcherRunner

Return shut down future of this runner. The shut down future is being completed with the final ApplicationStatus once the runner wants to shut down.

Specified by:

getShutDownFuture in interface DispatcherRunner

Returns:

future with the final application status

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface org.apache.flink.util.AutoCloseableAsync

grantLeadership

public void grantLeadership(UUID leaderSessionID)

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon selecting this instance as the new leader. The method is called with the new leader session ID.

Specified by:

grantLeadership in interface LeaderContender

Parameters:

leaderSessionID - New leader session ID

revokeLeadership

public void revokeLeadership()

Description copied from interface: LeaderContender

Callback method which is called by the LeaderElectionService upon revoking the leadership of a former leader. This might happen in case that multiple contenders have been granted leadership.

Specified by:

revokeLeadership in interface LeaderContender

handleError

public void handleError(Exception exception)

Description copied from interface: LeaderContender

Callback method which is called by LeaderElectionService in case of an error in the service thread.

Specified by:

handleError in interface LeaderContender

Parameters:

exception - Caught exception

create

public static DispatcherRunner create(LeaderElectionService leaderElectionService,
                                      org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler,
                                      DispatcherLeaderProcessFactory dispatcherLeaderProcessFactory)
                               throws Exception

Throws:

Exception