opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/TimedRunnable.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.raft;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import akka.actor.Cancellable;
  13 import scala.concurrent.duration.FiniteDuration;
  14
  15 /**
  16  * An abstract class that implements a Runnable operation with a timer such that if the run method isn't
  17  * invoked within a timeout period, the operation is cancelled via {@link #doCancel}.
  18  *
  19  * <p>
  20  * <b>Note:</b> this class is not thread safe and is intended for use only within the context of the same
  21  * actor that's passed on construction. The run method must be called on this actor's thread dispatcher as it
  22  * modifies internal state.
  23  *
  24  * @author Thomas Pantelis
  25  */
  26 abstract class TimedRunnable implements Runnable {
  27     private final Cancellable cancelTimer;
  28     private boolean canRun = true;
  29
  30     TimedRunnable(final FiniteDuration timeout, final RaftActor actor) {
  31         cancelTimer = requireNonNull(actor).getContext().system().scheduler()
  32                 .scheduleOnce(requireNonNull(timeout), actor.self(), (Runnable) this::cancel,
  33                     actor.getContext().system().dispatcher(), actor.self());
  34     }
  35
  36     @Override
  37     public void run() {
  38         if (canRun) {
  39             canRun = false;
  40             cancelTimer.cancel();
  41             doRun();
  42         }
  43     }
  44
  45     private void cancel() {
  46         canRun = false;
  47         doCancel();
  48     }
  49
  50     /**
  51      * Overridden to perform the operation if not previously cancelled or run.
  52      */
  53     protected abstract void doRun();
  54
  55     /**
  56      * Overridden to cancel the operation on time out.
  57      */
  58     protected abstract void doCancel();
  59 }