org.opendaylight.controller.cluster.raft.TimedRunnable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation

Controller documentation

There is a newer version: 10.0.4

/*
 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.raft;

import static java.util.Objects.requireNonNull;

import akka.actor.Cancellable;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import scala.concurrent.duration.FiniteDuration;

/**
 * An abstract class that implements a Runnable operation with a timer such that if the run method isn't
 * invoked within a timeout period, the operation is cancelled via {@link #doCancel}.
 *
 * 
 * Note: this class is not thread safe and is intended for use only within the context of the same
 * actor that's passed on construction. The run method must be called on this actor's thread dispatcher as it
 * modifies internal state.
 *
 * @author Thomas Pantelis
 */
abstract class TimedRunnable implements Runnable {
    private final Cancellable cancelTimer;
    private boolean canRun = true;

    @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR",
        justification = "https://github.com/spotbugs/spotbugs/issues/1867")
    TimedRunnable(final FiniteDuration timeout, final RaftActor actor) {
        cancelTimer = requireNonNull(actor).getContext().system().scheduler()
            .scheduleOnce(requireNonNull(timeout), actor.self(), (Runnable) this::cancel,
                actor.getContext().system().dispatcher(), actor.self());
    }

    @Override
    public void run() {
        if (canRun) {
            canRun = false;
            cancelTimer.cancel();
            doRun();
        }
    }

    private void cancel() {
        canRun = false;
        doCancel();
    }

    /**
     * Overridden to perform the operation if not previously cancelled or run.
     */
    protected abstract void doRun();

    /**
     * Overridden to cancel the operation on time out.
     */
    protected abstract void doCancel();
}