2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.raft;
10 import akka.actor.Cancellable;
11 import com.google.common.base.Preconditions;
12 import scala.concurrent.duration.FiniteDuration;
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}.
19 * <b>Note:</b> this class is not thread safe and is intended for use only within the context of the same
20 * actor that's passed on construction. The run method must be called on this actor's thread dispatcher as it
21 * modifies internal state.
23 * @author Thomas Pantelis
25 abstract class TimedRunnable implements Runnable {
26 private final Cancellable cancelTimer;
27 private boolean canRun = true;
29 TimedRunnable(FiniteDuration timeout, RaftActor actor) {
30 Preconditions.checkNotNull(timeout);
31 Preconditions.checkNotNull(actor);
32 cancelTimer = actor.getContext().system().scheduler().scheduleOnce(timeout, actor.self(),
33 (Runnable) () -> cancel(), actor.getContext().system().dispatcher(), actor.self());
45 private void cancel() {
51 * Overridden to perform the operation if not previously cancelled or run.
53 protected abstract void doRun();
56 * Overridden to cancel the operation on time out.
58 protected abstract void doCancel();