co.cask.cdap.data.stream.service.heartbeat

Interface HeartbeatPublisher

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

NoOpHeartbeatPublisher, NotificationHeartbeatPublisher

public interface HeartbeatPublisher
extends com.google.common.util.concurrent.Service

Publishes StreamWriterHeartbeats.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<StreamWriterHeartbeat>	sendHeartbeat(StreamWriterHeartbeat heartbeat) Publish one heartbeat.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Method Detail

sendHeartbeat

com.google.common.util.concurrent.ListenableFuture<StreamWriterHeartbeat> sendHeartbeat(StreamWriterHeartbeat heartbeat)

Publish one heartbeat.

Parameters:

heartbeat - heartbeat to publish

Returns:

a ListenableFuture describing the state of publishing. The Future.get() method will return the published heartbeat.