org.apache.flink.runtime.client

Class JobClientActor

java.lang.Object

akka.actor.UntypedActor

org.apache.flink.runtime.akka.FlinkUntypedActor

org.apache.flink.runtime.client.JobClientActor

All Implemented Interfaces:

akka.actor.Actor, LeaderRetrievalListener

Direct Known Subclasses:

JobAttachmentClientActor, JobSubmissionClientActor

public abstract class JobClientActor
extends FlinkUntypedActor
implements LeaderRetrievalListener

Actor which constitutes the bridge between the non-actor code and the JobManager. This base class handles the connection to the JobManager and notifies in case of timeouts. It also receives and prints job updates until job completion.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
protected akka.actor.ActorRef	client The client which the actor is responsible for
protected akka.actor.ActorRef	jobManager ActorRef to the current leader
protected UUID	leaderSessionID leader session ID of the JobManager when this actor was created
protected scala.concurrent.duration.FiniteDuration	timeout timeout for futures

Fields inherited from class org.apache.flink.runtime.akka.FlinkUntypedActor

LOG

Constructor Summary

Constructors

Constructor and Description
JobClientActor(LeaderRetrievalService leaderRetrievalService, scala.concurrent.duration.FiniteDuration timeout, boolean sysoutUpdates)

Method Summary

Modifier and Type	Method and Description
protected abstract void	connectedToJobManager() Hook to be called once a connection has been established with the JobManager.
protected abstract Class	getClientMessageClass() Hook to let the client know about messages that should start a timer for a timeout
protected UUID	getLeaderSessionID() Returns the current leader session ID associated with this actor.
protected abstract void	handleCustomMessage(Object message) Hook to handle custom client message which are not handled by the base class.
void	handleError(Exception exception) This method is called by the LeaderRetrievalService in case of an exception.
protected void	handleMessage(Object message) This method contains the actor logic which defines how to react to incoming messages.
protected boolean	isClientConnected()
protected void	logAndPrintMessage(String message)
void	notifyLeaderAddress(String leaderAddress, UUID leaderSessionID) This method is called by the LeaderRetrievalService when a new leader is elected.
void	postStop()
void	preStart()
protected void	terminate()

Methods inherited from class org.apache.flink.runtime.akka.FlinkUntypedActor

decorateMessage, onReceive

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, getContext, getSelf, getSender, postRestart, preRestart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

$init$, noSender

Field Detail

timeout

protected final scala.concurrent.duration.FiniteDuration timeout

timeout for futures

jobManager

protected akka.actor.ActorRef jobManager

ActorRef to the current leader

leaderSessionID

protected UUID leaderSessionID

leader session ID of the JobManager when this actor was created

client

protected akka.actor.ActorRef client

The client which the actor is responsible for

Constructor Detail

JobClientActor

public JobClientActor(LeaderRetrievalService leaderRetrievalService,
                      scala.concurrent.duration.FiniteDuration timeout,
                      boolean sysoutUpdates)

Method Detail

preStart

public void preStart()

Specified by:

preStart in interface akka.actor.Actor

Overrides:

preStart in class akka.actor.UntypedActor

postStop

public void postStop()

Specified by:

postStop in interface akka.actor.Actor

Overrides:

postStop in class akka.actor.UntypedActor

connectedToJobManager

protected abstract void connectedToJobManager()

Hook to be called once a connection has been established with the JobManager.

handleCustomMessage

protected abstract void handleCustomMessage(Object message)

Hook to handle custom client message which are not handled by the base class.

Parameters:

message - The message to be handled

getClientMessageClass

protected abstract Class getClientMessageClass()

Hook to let the client know about messages that should start a timer for a timeout

Returns:

The message class after which a timeout should be started

handleMessage

protected void handleMessage(Object message)

Description copied from class: FlinkUntypedActor

This method contains the actor logic which defines how to react to incoming messages.

Specified by:

handleMessage in class FlinkUntypedActor

Parameters:

message - Incoming message

getLeaderSessionID

protected UUID getLeaderSessionID()

Description copied from class: FlinkUntypedActor

Returns the current leader session ID associated with this actor.

Specified by:

getLeaderSessionID in class FlinkUntypedActor

Returns:

logAndPrintMessage

protected void logAndPrintMessage(String message)

notifyLeaderAddress

public void notifyLeaderAddress(String leaderAddress,
                                UUID leaderSessionID)

Description copied from interface: LeaderRetrievalListener

This method is called by the LeaderRetrievalService when a new leader is elected.

Specified by:

notifyLeaderAddress in interface LeaderRetrievalListener

Parameters:

leaderAddress - The address of the new leader

leaderSessionID - The new leader session ID

handleError

public void handleError(Exception exception)

Description copied from interface: LeaderRetrievalListener

This method is called by the LeaderRetrievalService in case of an exception. This assures that the LeaderRetrievalListener is aware of any problems occurring in the LeaderRetrievalService thread.

Specified by:

handleError in interface LeaderRetrievalListener

terminate

protected void terminate()

isClientConnected

protected boolean isClientConnected()