org.apache.flink.runtime.heartbeat

Interface HeartbeatServices

All Known Implementing Classes:

HeartbeatServicesImpl, NoOpHeartbeatServices

public interface HeartbeatServices

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

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(Configuration configuration) Creates an HeartbeatServices instance from a Configuration.
static HeartbeatServices	noOp()

Method Detail

createHeartbeatManager

<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

<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

static HeartbeatServices fromConfiguration(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

noOp

static HeartbeatServices noOp()