opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/ClientLocalHistory.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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.databroker.actors.dds;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Verify;
  13 import java.util.concurrent.atomic.AtomicLongFieldUpdater;
  14 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  16
  17 /**
  18  * Client-side view of a local history. This class tracks all state related to a particular history and routes
  19  * frontend requests towards the backend.
  20  *
  21  * <p>
  22  * This interface is used by the world outside of the actor system and in the actor system it is manifested via
  23  * its client actor. That requires some state transfer with {@link DistributedDataStoreClientBehavior}. In order to
  24  * reduce request latency, all messages are carbon-copied (and enqueued first) to the client actor.
  25  *
  26  * @author Robert Varga
  27  */
  28 @Beta
  29 public final class ClientLocalHistory extends AbstractClientHistory implements AutoCloseable {
  30
  31     private static final AtomicLongFieldUpdater<ClientLocalHistory> NEXT_TX_UPDATER =
  32             AtomicLongFieldUpdater.newUpdater(ClientLocalHistory.class, "nextTx");
  33
  34     // Used via NEXT_TX_UPDATER
  35     @SuppressWarnings("unused")
  36     private volatile long nextTx = 0;
  37
  38     ClientLocalHistory(final DistributedDataStoreClientBehavior client, final LocalHistoryIdentifier historyId) {
  39         super(client, historyId);
  40     }
  41
  42     public ClientTransaction createTransaction() {
  43         final State local = state();
  44         Preconditions.checkState(local == State.IDLE, "Local history %s state is %s", this, local);
  45         updateState(local, State.TX_OPEN);
  46
  47         return new ClientTransaction(this, new TransactionIdentifier(getIdentifier(),
  48             NEXT_TX_UPDATER.getAndIncrement(this)));
  49     }
  50
  51     @Override
  52     public void close() {
  53         final State local = state();
  54         if (local != State.CLOSED) {
  55             Preconditions.checkState(local == State.IDLE, "Local history %s has an open transaction", this);
  56             updateState(local, State.CLOSED);
  57         }
  58     }
  59
  60     @Override
  61     void onTransactionReady(final ClientTransaction transaction) {
  62         final State local = state();
  63         Verify.verify(local == State.TX_OPEN, "Local history %s is in unexpected state %s", this, local);
  64         updateState(local, State.IDLE);
  65         super.onTransactionReady(transaction);
  66     }
  67 }