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 akka.actor.Cancellable;
  11 import com.google.common.base.Preconditions;
  12 import scala.concurrent.duration.FiniteDuration;
  13
  14 /**
  15  * An abstract class that implements a Runnable operation with a timer such that if the run method isn't
  16  * invoked within a timeout period, the operation is cancelled via {@link #doCancel}.
  17  * <p>
  18  * <b>Note:</b> this class is not thread safe and is intended for use only within the context of the same
  19  * actor that's passed on construction. The run method must be called on this actor's thread dispatcher as it
  20  * modifies internal state.
  21  *
  22  * @author Thomas Pantelis
  23  */
  24 abstract class TimedRunnable implements Runnable {
  25     private final Cancellable cancelTimer;
  26     private boolean canRun = true;
  27
  28     TimedRunnable(FiniteDuration timeout, RaftActor actor) {
  29         Preconditions.checkNotNull(timeout);
  30         Preconditions.checkNotNull(actor);
  31         cancelTimer = actor.getContext().system().scheduler().scheduleOnce(timeout, actor.self(), new Runnable() {
  32             @Override
  33             public void run() {
  34                 cancel();
  35             }
  36         }, actor.getContext().system().dispatcher(), actor.self());
  37     }
  38
  39     @Override
  40     public void run() {
  41         if(canRun) {
  42             canRun = false;
  43             cancelTimer.cancel();
  44             doRun();
  45         }
  46     }
  47
  48     private void cancel() {
  49         canRun = false;
  50         doCancel();
  51     }
  52
  53     /**
  54      * Overridden to perform the operation if not previously cancelled or run.
  55      */
  56     protected abstract void doRun();
  57
  58     /**
  59      * Overridden to cancel the operation on time out.
  60      */
  61     protected abstract void doCancel();
  62 }