Package org.apache.flink.runtime.heartbeat

Class HeartbeatSender<I>

java.lang.Object

org.apache.flink.runtime.heartbeat.HeartbeatSender<I>

Type Parameters:

I - Type of the payload which is sent to the heartbeat target

All Implemented Interfaces:

HeartbeatTarget<I>

public abstract class HeartbeatSender<I>
extends Object
implements HeartbeatTarget<I>

The sender implementation of HeartbeatTarget, which mutes the HeartbeatTarget#receiveHeartbeat(ResourceID, I). The extender only has to care about the sending logic.

Constructor Summary

Constructors

Constructor	Description
HeartbeatSender()

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<Void>	receiveHeartbeat(ResourceID heartbeatOrigin, I heartbeatPayload)	Sends a heartbeat response to the target.

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.runtime.heartbeat.HeartbeatTarget

requestHeartbeat

Constructor Details

HeartbeatSender

public HeartbeatSender()

Method Details

receiveHeartbeat

public final CompletableFuture<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.

Returns:

Future that is completed exceptionally if the heartbeat response could not be sent to the target