Interface PushJobHeartbeatSender

  • All Superinterfaces:
    java.lang.Runnable
    All Known Implementing Classes:
    NoOpPushJobHeartbeatSender

    public interface PushJobHeartbeatSender
    extends java.lang.Runnable
    This interface provides methods to send push job heartbeats
    • Method Detail

      • getHeartbeatSendInterval

        java.time.Duration getHeartbeatSendInterval()
      • getHeartbeatInitialDelay

        java.time.Duration getHeartbeatInitialDelay()
      • start

        void start​(@Nonnull
                   java.lang.String storeName,
                   int storeVersion)
      • stop

        void stop()
      • getFirstSendHeartbeatException

        java.util.Optional<java.lang.Exception> getFirstSendHeartbeatException()
        Get first exception encountered while it is sending heartbeats. If there are multiple exceptions encountered during the process of sending heartbeats, only the first one is recorded and returned here.
        Returns:
        Empty optional if no exception