io.debezium.heartbeat

Interface Heartbeat

All Known Implementing Classes:

HeartbeatImpl

public interface Heartbeat

A class that is able to generate periodic heartbeat messages based on a pre-configured interval. The clients are supposed to call method #heartbeat(Consumer) from a main loop of a connector.

Author:

Jiri Pechanec

Field Summary

Fields

Modifier and Type	Field and Description
static Field	HEARTBEAT_INTERVAL
static Field	HEARTBEAT_TOPICS_PREFIX
static Heartbeat	NULL No-op Heartbeat implementation

Method Summary

Modifier and Type	Method and Description
static Heartbeat	create(Configuration configuration, String topicName, String key) Provide an instance of Heartbeat object
void	forcedBeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer) Generates a heartbeat record unconditionaly
void	heartbeat(Map<String,?> partition, Map<String,?> offset, BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer) Generates a heartbeat record if defined time has elapsed

Field Detail

HEARTBEAT_INTERVAL

static final Field HEARTBEAT_INTERVAL

HEARTBEAT_TOPICS_PREFIX

static final Field HEARTBEAT_TOPICS_PREFIX

NULL

static final Heartbeat NULL

No-op Heartbeat implementation

Method Detail

heartbeat

void heartbeat(Map<String,?> partition,
               Map<String,?> offset,
               BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
        throws InterruptedException

Generates a heartbeat record if defined time has elapsed

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

forcedBeat

void forcedBeat(Map<String,?> partition,
                Map<String,?> offset,
                BlockingConsumer<org.apache.kafka.connect.source.SourceRecord> consumer)
         throws InterruptedException

Generates a heartbeat record unconditionaly

Parameters:

partition - partition for the heartbeat record

offset - offset for the heartbeat record

consumer - - a code to place record among others to be sent into Connect

Throws:

InterruptedException

create

static Heartbeat create(Configuration configuration,
                        String topicName,
                        String key)

Provide an instance of Heartbeat object

Parameters:

configuration - - connector configuration

topicName - - topic to which the heartbeat messages will be sent

Returns: