org.apache.flink.runtime.heartbeat

Class HeartbeatServices

java.lang.Object

org.apache.flink.runtime.heartbeat.HeartbeatServices

public class HeartbeatServices
extends Object

HeartbeatServices gives access to all services needed for heartbeating. This includes the creation of heartbeat receivers and heartbeat senders.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	heartbeatInterval Heartbeat interval for the created services.
protected long	heartbeatTimeout Heartbeat timeout for the created services.

Constructor Summary

Constructors

Constructor and Description
HeartbeatServices(long heartbeatInterval, long heartbeatTimeout)

Method Summary

Modifier and Type	Method and Description
<I,O> HeartbeatManager<I,O>	createHeartbeatManager(ResourceID resourceId, HeartbeatListener<I,O> heartbeatListener, ScheduledExecutor mainThreadExecutor, org.slf4j.Logger log) Creates a heartbeat manager which does not actively send heartbeats.
<I,O> HeartbeatManager<I,O>	createHeartbeatManagerSender(ResourceID resourceId, HeartbeatListener<I,O> heartbeatListener, ScheduledExecutor mainThreadExecutor, org.slf4j.Logger log) Creates a heartbeat manager which actively sends heartbeats to monitoring targets.
static HeartbeatServices	fromConfiguration(org.apache.flink.configuration.Configuration configuration) Creates an HeartbeatServices instance from a Configuration.

Methods inherited from class java.lang.Object

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

Field Detail

heartbeatInterval

protected final long heartbeatInterval

Heartbeat interval for the created services.

heartbeatTimeout

protected final long heartbeatTimeout

Heartbeat timeout for the created services.

Constructor Detail

HeartbeatServices

public HeartbeatServices(long heartbeatInterval,
                         long heartbeatTimeout)

Method Detail

createHeartbeatManager

public <I,O> HeartbeatManager<I,O> createHeartbeatManager(ResourceID resourceId,
                                                          HeartbeatListener<I,O> heartbeatListener,
                                                          ScheduledExecutor mainThreadExecutor,
                                                          org.slf4j.Logger log)

Creates a heartbeat manager which does not actively send heartbeats.

Type Parameters:

I - Type of the incoming payload

O - Type of the outgoing payload

Parameters:

resourceId - Resource Id which identifies the owner of the heartbeat manager

heartbeatListener - Listener which will be notified upon heartbeat timeouts for registered targets

mainThreadExecutor - Scheduled executor to be used for scheduling heartbeat timeouts

log - Logger to be used for the logging

Returns:

A new HeartbeatManager instance

createHeartbeatManagerSender

public <I,O> HeartbeatManager<I,O> createHeartbeatManagerSender(ResourceID resourceId,
                                                                HeartbeatListener<I,O> heartbeatListener,
                                                                ScheduledExecutor mainThreadExecutor,
                                                                org.slf4j.Logger log)

Creates a heartbeat manager which actively sends heartbeats to monitoring targets.

Type Parameters:

I - Type of the incoming payload

O - Type of the outgoing payload

Parameters:

resourceId - Resource Id which identifies the owner of the heartbeat manager

heartbeatListener - Listener which will be notified upon heartbeat timeouts for registered targets

mainThreadExecutor - Scheduled executor to be used for scheduling heartbeat timeouts and periodically send heartbeat requests

log - Logger to be used for the logging

Returns:

A new HeartbeatManager instance which actively sends heartbeats

fromConfiguration

public static HeartbeatServices fromConfiguration(org.apache.flink.configuration.Configuration configuration)

Creates an HeartbeatServices instance from a Configuration.

Parameters:

configuration - Configuration to be used for the HeartbeatServices creation

Returns:

An HeartbeatServices instance created from the given configuration