org.apache.flink.runtime.heartbeat

Class HeartbeatManagerImpl<I,O>

java.lang.Object

org.apache.flink.runtime.heartbeat.HeartbeatManagerImpl<I,O>

Type Parameters:

I - Type of the incoming heartbeat payload

O - Type of the outgoing heartbeat payload

All Implemented Interfaces:

HeartbeatManager<I,O>, HeartbeatTarget<I>

Direct Known Subclasses:

HeartbeatManagerSenderImpl

@ThreadSafe
public class HeartbeatManagerImpl<I,O>
extends Object
implements HeartbeatManager<I,O>

Heartbeat manager implementation. The heartbeat manager maintains a map of heartbeat monitors and resource IDs. Each monitor will be updated when a new heartbeat of the associated machine has been received. If the monitor detects that a heartbeat has timed out, it will notify the HeartbeatListener about it. A heartbeat times out iff no heartbeat signal has been received within a given timeout interval.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected boolean	stopped Running state of the heartbeat manager.

Constructor Summary

Constructors

Constructor and Description
HeartbeatManagerImpl(long heartbeatTimeoutIntervalMs, ResourceID ownResourceID, HeartbeatListener<I,O> heartbeatListener, ScheduledExecutor mainThreadExecutor, org.slf4j.Logger log)

Method Summary

Modifier and Type	Method and Description
long	getLastHeartbeatFrom(ResourceID resourceId) Returns the last received heartbeat from the given target.
void	monitorTarget(ResourceID resourceID, HeartbeatTarget<O> heartbeatTarget) Start monitoring a HeartbeatTarget.
void	receiveHeartbeat(ResourceID heartbeatOrigin, I heartbeatPayload) Sends a heartbeat response to the target.
void	requestHeartbeat(ResourceID requestOrigin, I heartbeatPayload) Requests a heartbeat from the target.
void	stop() Stops the heartbeat manager.
void	unmonitorTarget(ResourceID resourceID) Stops monitoring the heartbeat target with the associated resource ID.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

stopped

protected volatile boolean stopped

Running state of the heartbeat manager.

Constructor Detail

HeartbeatManagerImpl

public HeartbeatManagerImpl(long heartbeatTimeoutIntervalMs,
                            ResourceID ownResourceID,
                            HeartbeatListener<I,O> heartbeatListener,
                            ScheduledExecutor mainThreadExecutor,
                            org.slf4j.Logger log)

Method Detail

monitorTarget

public void monitorTarget(ResourceID resourceID,
                          HeartbeatTarget<O> heartbeatTarget)

Description copied from interface: HeartbeatManager

Start monitoring a HeartbeatTarget. Heartbeat timeouts for this target are reported to the HeartbeatListener associated with this heartbeat manager.

Specified by:

monitorTarget in interface HeartbeatManager<I,O>

Parameters:

resourceID - Resource ID identifying the heartbeat target

heartbeatTarget - Interface to send heartbeat requests and responses to the heartbeat target

unmonitorTarget

public void unmonitorTarget(ResourceID resourceID)

Description copied from interface: HeartbeatManager

Stops monitoring the heartbeat target with the associated resource ID.

Specified by:

unmonitorTarget in interface HeartbeatManager<I,O>

Parameters:

resourceID - Resource ID of the heartbeat target which shall no longer be monitored

stop

public void stop()

Description copied from interface: HeartbeatManager

Stops the heartbeat manager.

Specified by:

stop in interface HeartbeatManager<I,O>

getLastHeartbeatFrom

public long getLastHeartbeatFrom(ResourceID resourceId)

Description copied from interface: HeartbeatManager

Returns the last received heartbeat from the given target.

Specified by:

getLastHeartbeatFrom in interface HeartbeatManager<I,O>

Parameters:

resourceId - for which to return the last heartbeat

Returns:

Last heartbeat received from the given target or -1 if the target is not being monitored.

receiveHeartbeat

public void receiveHeartbeat(ResourceID heartbeatOrigin,
                             I heartbeatPayload)

Description copied from interface: HeartbeatTarget

Sends a heartbeat response to the target. Each heartbeat response can carry a payload which contains additional information for the heartbeat target.

Specified by:

receiveHeartbeat in interface HeartbeatTarget<I>

Parameters:

heartbeatOrigin - Resource ID identifying the machine for which a heartbeat shall be reported.

heartbeatPayload - Payload of the heartbeat. Null indicates an empty payload.

requestHeartbeat

public void requestHeartbeat(ResourceID requestOrigin,
                             I heartbeatPayload)

Description copied from interface: HeartbeatTarget

Requests a heartbeat from the target. Each heartbeat request can carry a payload which contains additional information for the heartbeat target.

Specified by:

requestHeartbeat in interface HeartbeatTarget<I>

Parameters:

requestOrigin - Resource ID identifying the machine issuing the heartbeat request.

heartbeatPayload - Payload of the heartbeat request. Null indicates an empty payload.