com.github.kagkarlsson.scheduler.Waiter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of db-scheduler Show documentation
Simple persistent scheduler for scheduled tasks, recurring or ad-hoc.
There is a newer version: 15.0.0
/*
 * Copyright (C) Gustav Karlsson
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 *
 * 
http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.kagkarlsson.scheduler;

import java.time.Duration;
import java.time.Instant;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Waiter {
  private static final Logger LOG = LoggerFactory.getLogger(Waiter.class);

  private final Object lock;
  private boolean woken = false;
  private final Duration duration;
  private Clock clock;
  private boolean isWaiting = false;
  private boolean skipNextWait = false;

  public Waiter(Duration duration) {
    this(duration, new SystemClock());
  }

  public Waiter(Duration duration, Clock clock) {
    this(duration, clock, new Object());
  }

  Waiter(Duration duration, Clock clock, Object lock) {
    this.duration = duration;
    this.clock = clock;
    this.lock = lock;
  }

  public void doWait() throws InterruptedException {
    long millis = duration.toMillis();

    if (millis > 0) {
      Instant waitUntil = clock.now().plusMillis(millis);

      while (clock.now().isBefore(waitUntil)) {
        synchronized (lock) {
          if (skipNextWait) {
            LOG.debug("Waiter has been notified to skip next wait-period. Skipping wait.");
            skipNextWait = false;
            return;
          }

          woken = false;
          LOG.debug("Waiter start wait.");
          this.isWaiting = true;
          lock.wait(millis);
          this.isWaiting = false;
          if (woken) {
            LOG.debug(
                "Waiter woken, it had {}ms left to wait.",
                (waitUntil.toEpochMilli() - clock.now().toEpochMilli()));
            return;
          }
        }
      }
    }
  }

  public boolean wake() {
    synchronized (lock) {
      if (!isWaiting) {
        return false;
      } else {
        woken = true;
        lock.notify();
        return true;
      }
    }
  }

  public void wakeOrSkipNextWait() {
    // Take early lock to avoid race-conditions. Lock is also taken in wake() (lock is re-entrant)
    synchronized (lock) {
      final boolean awoken = wake();
      if (!awoken) {
        LOG.debug("Waiter not waiting, instructing to skip next wait.");
        this.skipNextWait = true;
      }
    }
  }

  public Duration getWaitDuration() {
    return duration;
  }

  public boolean isWaiting() {
    return isWaiting;
  }
}