org.apache.flink.runtime.registration

Class RegisteredRpcConnection<Gateway extends RpcGateway,Success extends RegistrationResponse.Success>

java.lang.Object

org.apache.flink.runtime.registration.RegisteredRpcConnection<Gateway,Success>

Type Parameters:

Gateway - The type of the gateway to connect to.

Success - The type of the successful registration responses.

Direct Known Subclasses:

TaskExecutorToResourceManagerConnection

public abstract class RegisteredRpcConnection<Gateway extends RpcGateway,Success extends RegistrationResponse.Success>
extends Object

This utility class implements the basis of RPC connecting from one component to another component, for example the RPC connection from TaskExecutor to ResourceManager. This RegisteredRpcConnection implements registration and get target gateway.

The registration gives access to a future that is completed upon successful registration. The RPC connection can be closed, for example when the target where it tries to register at looses leader status.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log the logger for all log messages of this class

Constructor Summary

Constructors

Constructor and Description
RegisteredRpcConnection(org.slf4j.Logger log, String targetAddress, UUID targetLeaderId, Executor executor)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() close connection
protected abstract RetryingRegistration<Gateway,Success>	generateRegistration() This method generate a specific Registration, for example TaskExecutor Registration at the ResourceManager
String	getTargetAddress()
Gateway	getTargetGateway() Gets the RegisteredGateway.
UUID	getTargetLeaderId()
boolean	isClosed()
boolean	isConnected()
protected abstract void	onRegistrationFailure(Throwable failure) This method handle the Registration failure
protected abstract void	onRegistrationSuccess(Success success) This method handle the Registration Response
void	start()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

the logger for all log messages of this class

Constructor Detail

RegisteredRpcConnection

public RegisteredRpcConnection(org.slf4j.Logger log,
                       String targetAddress,
                       UUID targetLeaderId,
                       Executor executor)

Method Detail

start

public void start()

generateRegistration

protected abstract RetryingRegistration<Gateway,Success> generateRegistration()

This method generate a specific Registration, for example TaskExecutor Registration at the ResourceManager

onRegistrationSuccess

protected abstract void onRegistrationSuccess(Success success)

This method handle the Registration Response

onRegistrationFailure

protected abstract void onRegistrationFailure(Throwable failure)

This method handle the Registration failure

close

public void close()

close connection

isClosed

public boolean isClosed()

getTargetLeaderId

public UUID getTargetLeaderId()

getTargetAddress

public String getTargetAddress()

getTargetGateway

public Gateway getTargetGateway()

Gets the RegisteredGateway. This returns null until the registration is completed.

isConnected

public boolean isConnected()

toString

public String toString()

Overrides:

toString in class Object